Skip to content

Commit

Permalink
Merge pull request #1297 from newrelic/ruairi/branch-protection-workflow
Browse files Browse the repository at this point in the history
chore: documenting dev branch protection
  • Loading branch information
rudouglas authored May 4, 2021
2 parents 0815254 + e1fcec7 commit 19fb479
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
- [Submitting a PR from a forked repo](#submitting-a-pr-from-a-forked-repo)
- [Submitting a PR from a cloned repo](#submitting-a-pr-from-a-cloned-repo)
- [Using the `develop` branch](#using-the-develop-branch)
- [Branch Protection](#branch-protection)
- [Using Conventional Commits](#using-conventional-commits)
- [Use `chore`](#use-chore)
- [Use `fix`](#use-fix)
Expand Down Expand Up @@ -116,6 +117,14 @@ current source code. The `develop` branch will be merged into the `main` branch

All pull requests should be made against the `develop` branch.

### Branch Protection

The `develop` and `main` branches have "Branch Protection" enabled in Github. In order to merge a pull request into `develop`, you must have (at least) one approval. Additionally a few of the "PR Checks" are required and must pass before the pull request can be merged in.

You can review full Branch Protection details [here](https://docs.google.com/document/d/1O1SGS0i3OmPfvPhylpFe1CTMkE20889iAOF_cMFJ344/edit#heading=h.cy3jfpnyvv5z), and check out a visual representation of the workflow below:

![](src/images/Dev_site_branch_protection_workflow_(develop_main).png)

### Using Conventional Commits

Please help the maintainers by leveraging the following [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/)
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 19fb479

Please sign in to comment.