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

Improve contributing guide & docs #1139

Merged
merged 11 commits into from
Feb 23, 2024
Merged

Conversation

bourgeoisor
Copy link
Member

@bourgeoisor bourgeoisor commented Feb 12, 2024

This PR:

  • Completely revamps and cleans up the contributing guide
  • Adds various templates for new samples
  • Cleans up the root README
  • Adds a template for new PRs

How to review?

@bourgeoisor bourgeoisor marked this pull request as ready for review February 12, 2024 22:34
@bourgeoisor bourgeoisor requested review from yoshi-approver and a team as code owners February 12, 2024 22:34
Copy link

snippet-bot bot commented Feb 12, 2024

Here is the summary of changes.

You are about to add 1 region tag.

This comment is generated by snippet-bot.
If you find problems with this result, please file an issue at:
https://github.com/googleapis/repo-automation-bots/issues.
To update this comment, add snippet-bot:force-run label or use the checkbox below:

  • Refresh this comment

.github/CONTRIBUTING.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
* [ ] 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.
Copy link
Collaborator

@NimJay NimJay Feb 15, 2024

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.

Suggested change
* [ ] 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.

Copy link
Member Author

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"

Copy link
Collaborator

@NimJay NimJay left a 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.

.github/CONTRIBUTING.md Outdated Show resolved Hide resolved
@bourgeoisor
Copy link
Member Author

Cleaned up the contributing guide some more.

Will merge as-is, but always open to improvement / tweaks even post-merge!

@bourgeoisor bourgeoisor merged commit a1e433f into main Feb 23, 2024
9 checks passed
@bourgeoisor bourgeoisor deleted the issue-improve-contributing branch February 23, 2024 19:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants