Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Provide Better Guidance in CONTRIBUTING.md #797

Closed
NimJay opened this issue Apr 6, 2022 · 1 comment · Fixed by #1301
Closed

Provide Better Guidance in CONTRIBUTING.md #797

NimJay opened this issue Apr 6, 2022 · 1 comment · Fixed by #1301
Assignees
Labels
priority: p2 Moderately-important priority. Fix may not be included in next release. type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design.

Comments

@NimJay
Copy link
Collaborator

NimJay commented Apr 6, 2022

Describe request or inquiry

  • We receive a lot of incredible external contributions to this repo (from non-Googlers and Googlers outside the team that owns this repo).
  • But our current CONTRIBUTING.md file doesn't contain useful information about how to contribute and what to expect when creating a pull-request.
  • To respect external contributors, we should elaborate on these points:
    • some changes need to be tested on a GKE cluster manually (e.g., sometimes using skaffold to make sure development still works)
    • large changes require Google-internal design reviews (i.e., a design phase)
    • each PR will be deployed to a GKE cluster (so some automated testing exists)
    • some product showcases are out-of-scope for this repo and should live in externally-owned repos
    • etc.

Additional Info

@xtineskim xtineskim added priority: p3 Desirable enhancement or fix. May not be included in next release. type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design. labels Apr 6, 2022
@NimJay
Copy link
Collaborator Author

NimJay commented Oct 6, 2022

Update
There is now a Google Doc for Googlers (go/online-boutique-contribute), but go/online-boutique-contribute does not help non-Googlers (inaccessible) and doesn't contain guidance around pull-request, so let's keep this issue open.
We will see how this issue fits into the 2023 plan for Online Boutique.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority: p2 Moderately-important priority. Fix may not be included in next release. type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants