Move branch protection to extras #230
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Since there is quite a lot of text, put under actual headings rather than as part of the bullet point list
These instructions mean that on a shared repository the pull request system must be used. This prevents accidentally pushing to the main branch, as well as ensuring people get into the habbit of raising pull requests for their changes.
… a list Co-authored-by: Aleksandra Nenadic <a.nenadic@manchester.ac.uk>
This is quite detailed and isn't directly connected to the topic of code review. Further, it is GitHub specific and someones repository might already be setup correctly.
Since this text is a callout box, having full size headers feels wrong.
It is only about protecting branches, so remove padding to indicate it might be about other GitHub settings - can be changed to that in the future if required
This extra now only covers protecting the main branch
anenadic
approved these changes
Aug 10, 2023
Collaborator
|
Thank you @thomaskileyukaea 👍 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This builds on #213, but moves the detailed info about how to protect branches into an extras page.
The motivation for having this as an extra, rather than inline: