Before Pushing or When Creating the PR

Before Push

  • The commit message format was checked.
  • The commit history was cleaned up (interactive rebase).
  • Build scripts where checked (use the Build Script Notifier plugin ⧉).
  • All (new) migrations were run.
  • All relevant tests are green.
  • TODO comments were checked.

GitHub

  • Tickets that were fixed/implemented are mentioned.
  • Branch naming conventions were followed.
  • Tests don't fail.
  • No Model check errors.
  • Linters don't fail.
  • Only changes are mentioned that are relevant for the user/developer in the changelog.
    • for example: no implementation details or cleanups
  • The PR description mentions how the feature was implemented if it is not clear to the reviewer
  • The PR title format was followed.
  • The PR description format was followed.

Last update: August 24, 2023

Comments