Skip to content

Make a pull request

QLutz edited this page Jul 26, 2021 · 3 revisions

There are a few rules to follow when creating a pull request on the repository:

  • Get a nice name: use prefixes to name your branch. For instance, if you are implementing a new feature, use the feat/ keyword (e.g. name your branch feat/my-brand-new-feature).

  • Use the designated PR template.

  • Target develop: pull requests to master should only come from develop, all other branches must target develop.

  • Make sure the tests pass: when looking at your PR on GitHub, you should be able to see the checks that GitHub Actions and CodeCov have run for you. Make sure those pass.

  • Update the HISTORY: before merging your branch, describe what you did for the changelog in HISTORY.rst. If needed, create a new release space (named 'Next release' or similar).

Clone this wiki locally