Skip to content

Git best practices

The models and guidelines here are recommended by the PinkSalmon teams and are not mandatory.

They are strongly recommended when:

  • Using other PinkSalmon cloud services.
  • Contributing to development with PinkSalmon teams.

Tip

If you are unfamiliar with Git, read Git Basics.

Branches

Strategy

The recommended Git branching model is Gitflow.

Best practices

  • Use only lowercase letters in branch names.
  • Branches you create should always start with feature/, bugfix/ or release/.

Merge requests and pull requests

Best practices

  • Use the prefix draft: or WIP: until the merge request or pull request is ready for review.

Before submitting your merge request or pull request for review:

  • Check that your branch name follows the guidelines.
  • Perform a rebase.
  • Resolve any conflicts.
  • Check that you have run the tests and they passed, where applicable.
  • Check that the documentation reflects your changes, where applicable.
  • Check that the README reflects your changes, where applicable.
  • Check that the build works in your environment if you changed a build resource, where applicable.