Skip to content

Document the repo's branch protection rules #50

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jan 7, 2025
Merged

Document the repo's branch protection rules #50

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ To suggest a feature or enhancement, open an issue on GitHub with the label
`feature` or `enhancement` using the available feature request issue template.
Please ensure the feature or enhancement has not already been suggested.

## Open a discussion
## Open a Discussion

If you want to start a conversation with the community and maintainers,
we encourage you to use
Expand All @@ -48,7 +48,7 @@ To contribute to F5 NGINX documentation, follow these steps:
Alternatively, you're welcome to suggest improvements to highlight problems with
our documentation as described in our [support](./SUPPORT.md) page.

### Git Style Guide
### Git style guide

- Keep a clean, concise and meaningful Git commit history on your branch, rebasing locally and squashing before you submit a PR
- Follow the guidelines of writing a good commit message as described here <https://chris.beams.io/posts/git-commit/>
Expand All @@ -61,6 +61,15 @@ our documentation as described in our [support](./SUPPORT.md) page.
- Add more detailed description in the body of the git message (`git commit -a` to give you more space and time in
your text editor to write a good message instead of `git commit -am`)

#### Branch protection rules

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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

- **Only NGINX DocOps Team members can create release branches.** This ensures the docs team is aware of all branches supporting specific product releases. This rule applies to all branches with `*release*` in the branch name.
- **Pushes (force or otherwise) directly to main or release branches is not allowed.** Release branches serve as "main" for the release they are associated with. Restricting pushes directly to main and release branches ensures all content changes are reviewed and approved. This rule applies to all branches with `*release*` in the branch name and to "main".

### Documentation style guide

For detailed guidance, see our documentation [style guide](./templates/style-guide.md).
Expand Down
Loading