Document the repo's branch protection rules #50
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
This commit adds a section on the repo's branch protection rules to the CONTRIBUTING doc.
|
✅ All required contributors have signed the F5 CLA for this PR. Thank you! |
|
I have hereby read the F5 CLA and agree to its terms |
✅ Deploy Preview will be available once build job completes!
|
ADubhlaoich
approved these changes
Jan 7, 2025
1 task
I debated the discussion change. I decided it should be capitalized because it's a proper noun in GitHub parlance. Happy to change back if that's preferred! |
mjang
reviewed
Jan 7, 2025
| This repository has the following branch protection rules in place: | ||
|
|
||
| - **Pushing branches that contain the "internal/" prefix is not allowed.** This ensures internal development branches are not accidentally or purposefully pushed to this repo. | ||
| - **Two approvers are required for all merges to main and release branches.** This ensures all code that is approved for release to production is appropriately reviewed. This rule applies to all branches with `*release*` in the branch name. |
There was a problem hiding this comment.
Info: we should also update https://github.com/nginx/documentation/blob/main/.github/pull_request_template.md#checklist accordingly. I know @ADubhlaoich is currently working on this file.
mjang
approved these changes
Jan 7, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 commit adds a section on the repo's branch protection rules to the CONTRIBUTING doc.
Proposed changes
Write a clear and concise description that helps reviewers understand the purpose and impact of your changes. Use the
following format:
Problem: Give a brief overview of the problem or feature being addressed.
Solution: Explain the approach you took to implement the solution, highlighting any significant design decisions or
considerations.
Testing: Describe any testing that you did.
Please focus on (optional): If you any specific areas where you would like reviewers to focus their attention or provide
specific feedback, add them here.
If this PR addresses an issue on GitHub, ensure that you link to it here:
Closes #ISSUE
Checklist
Before creating a PR, run through this checklist and mark each as complete.
I have read the contributing guidelines
I have signed the F5 Contributor License Agreement (CLA)
If applicable, I have added tests that prove my fix is effective or that my feature works
If applicable, I have checked that any relevant tests pass after adding my changes
I have updated any relevant documentation (
README.mdandCHANGELOG.md)I have rebased my branch onto main
I will ensure my PR is targeting the main branch and pulling from my branch from my own fork
If the change involves:
<username>in place of PIIIn these cases, the change will require at least two (2) approvals before merging