Skip to content
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.

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

Branching Model Team Agreement #14

Closed
wenzowski opened this issue Dec 1, 2021 · 2 comments · Fixed by #18
Closed

Branching Model Team Agreement #14

wenzowski opened this issue Dec 1, 2021 · 2 comments · Fixed by #18
Labels
help wanted Extra attention is needed

Comments

@wenzowski
Copy link

A place to start on a few branching model team agreements to consider adopting:

  • Be as lightweight as possible in our approach, and only focus on adopting team agreements that will add value to our future selves.
  • Adopt the main branch as our default branch.
  • Agree never to commit directly on main under any circumstances, and implement branch protection rules as a guardrail to enforce the agreement, including enforcement to administrators of this repo.
  • Make draft pull requests early and often to facilitate a transparent process.
  • Ruthlessly delete branches that aren't tied directly to an open pull request.
  • Adopt Conventional Commits standard for commit messages, and consider authoring commit messages using Commitizen to make the spec easier while ensuring notes stay informative.
  • Follow peer review best practices by suggesting opportunities to improve code during peer review, merging as soon as the code is better than the code in the target branch and release ready.
  • Treat any opportunity for improvement feedback identified during peer review but not implemented in the PR where it was raised as technical debt worthy of a new issue referencing the PR where the comments first came up.
  • Commit finalized agreements in docs/branching_model.md as a living document, to ensure any decision can be updated as and when required.
@wenzowski wenzowski added the help wanted Extra attention is needed label Dec 1, 2021
@wenzowski wenzowski mentioned this issue Dec 1, 2021
@kriscooke
Copy link

I would like to second each of these motions above ✅

@BCerki
Copy link
Collaborator

BCerki commented Dec 1, 2021

Thirded

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants