-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
Improve contributing guide & docs #1139
Conversation
Here is the summary of changes. You are about to add 1 region tag.
This comment is generated by snippet-bot.
|
* [ ] The [contributing guide](/.github/CONTRIBUTING.md) has been read and followed. | ||
* [ ] The samples added / modified have been fully tested. | ||
* [ ] Workflow files have been added / modified, if applicable. | ||
* [ ] Region tags have been properly added, if new samples. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggestion:
I assume some contributors won't know what a "region tag" is.
* [ ] Region tags have been properly added, if new samples. | |
* [ ] [Region tags](https://github.com/GoogleCloudPlatform/kubernetes-engine-samples/discussions/878) have been properly added, if new samples. |
Feel free to ignore this suggestion or use a different link.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thought about it but I think it's best to keep all source of truth / docs / details in the "contributing.md" file (which the PR template points to). My answer to "what if someone doesn't know what a region tag is" would be "then they haven't read the contributing guide, which is the first checkbox they're supposed to check"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks amazing! Thanks, @bourgeoisor!
Approved. Feel free to merge whenever — my comments a mostly minor issues.
Co-authored-by: Nim Jayawardena <[email protected]>
Cleaned up the contributing guide some more. Will merge as-is, but always open to improvement / tweaks even post-merge! |
This PR:
How to review?