-
Notifications
You must be signed in to change notification settings - Fork 8
GitHub workflow updates #514
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
Conversation
… after merging a PR
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.
These are great updates! I haven't had a chance to review the issues to see if this fits the brief. I made some small suggestions. Also, as one comment says, I haven't found the docs on rulesets and would love to review that. For those reasons, I'm making this a comment instead of a approval, but feel free to merge if you need to. Thanks!
@@ -94,11 +108,15 @@ You can also [close issues in commit messages and pull request descriptions](htt | |||
|
|||
### Use branches {#branches} | |||
|
|||
Use branches to isolate the feature, bug, or other issue you are working on. Commit to the branch as you edit, and then when you are finished making your changes, [create a pull request](#pull-requests) to merge the branch into **main**. | |||
As a general rule, avoid committing to **main**—the default branch. Instead, update **main** with pull requests from other branches. (You can require this by [protecting your repository](#protect-repo).) |
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.
Note to self: https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/managing-a-branch-protection-rule#creating-a-branch-protection-rule – "Restrict who can push to matching branches."
This PR adds some commit checklists and closes #513. It also adds a recommended branch protection ruleset to close #510. And it adds a collaboration section, including things to avoid, like forking, which closes #116.