Skip to content

Latest commit

 

History

History
21 lines (15 loc) · 1003 Bytes

WORKFLOW.md

File metadata and controls

21 lines (15 loc) · 1003 Bytes

Branch Naming Convention

Branches to be merged must be named in the following fashion in order to trigger CI:

$INITIALS/$DESCRIPTION

Example: if the initials are jr and the description is add_a_feature, then the branch would be jr/add_a_feature

Best Practices

  • No pushing to main at all, only through pull requests
    • Releases are a pull request with just the release version bump, release after this is merged into main: bincode-org/bincode#510
  • Only append commits to a pull request, don't rebase/squash/force push anything because this makes reviewing more annoying
    • Force pushing when rebasing onto main is fine, but merge commits are also fine
  • Reviewers should only review/approve, let the creator of the PR complete the PR
  • Always squash & merge when completing your pull request
    • The full history will be in the pull request
    • The main branch will have a single commit with the summary of the PR with a link if you want more details