- Pull requests must contain a succinct, clear summary of the change is and why it is being made
- Follow the GDS Git styleguide
- Make a feature branch following the Git Flow
naming convention. For example
feature/my-new-feature. - Ensure your branch contains logical atomic commits before sending a pull request
- Pull requests are automatically tested, where applicable using CircleCI, which will report back on whether the tests still pass on your branch
- You may rebase your branch after feedback if it's to include relevant updates from the main branch. We prefer a rebase here to a merge commit as we prefer a clean and straight history on main with discrete merge commits for features
- Features are merged onto the
mainbranch
- Must be readable with meaningful naming, eg no short hand single character variable names
- See GDS styleguides for examples
Write tests.
We use Semantic Versioning, and bump the version on main only. Please don't submit your own proposed version numbers.