Suggest to protect branches on shared repo #212
Closed
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
To make the unformatted markdown easier to read, introduce some line breaks
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.
Contributor
Author
|
Replaced by #213 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Previously the course said that on a shared repository everyone can push to the main branch, but people should be encouraged to raise pull requests.
GitHub you can enforce this action by protecting the main branch.
I think the course should be instruction the attendees to do this. Without branch protection, it is very easy to accidentally push to the main branch, which can disrupt other developers, miss out on the advantages CI and code review give you, and create confusion about whether that is ever the right approach.
This change alters the text to instruct attendees how to configure branch protection with sensible defaults, and suggests that they do that.
As the text is no longer suitable for a bullet point (and it was pretty long before!) I also put the content under a header. It might be easiest to review the changes commit by commit.