Shift3 / standards-and-practices

Standards and Practices for Bitwise Industries
https://shift3.github.io/standards-and-practices/
63 stars 41 forks source link

[Feat]: Branch protection recommendations #315

Closed michaelachrisco closed 2 years ago

michaelachrisco commented 2 years ago

Is your feature request related to a problem? Please describe.

At the moment, we leave branch protection to team leads. While this has worked for us in the past, we are now getting questions on the PR-Team not being able to merge when the incorrect selection of Github rights are added to a repo.

Describe the solution you'd like.

We should provide recommendations on how Team leads set up github branch protection as well as team assignment to repos. I personally recommend enforcing branch protection on at least the development branch and main branches on projects to prevent accidental pushes to the branch. It seems to work pretty well on our other boilerplate projects.

Describe alternatives you've considered

Adding more permissive rights to the PR-Team was also discussed at one point. But giving the PR-Team Write capabilities with branch protection on development/main has proven to be a good combination.

Additional context

No response