xrefcheck/.github/pull_request_template.md
2019-03-14 20:29:36 +03:00

1.8 KiB

Description

Checklist for your Pull Request

Ideally a PR has all of the checkmarks set.

If something in this list is irrelevant to your PR, you should still set this checkmark indicating that you are sure it is dealt with (be that by irrelevance).

  • Tests
    • If I added new functionality, I added tests covering it.
    • If I fixed a bug, I added a regression test to prevent the bug from silently reappearing again.
  • Documentation
    • I checked whether I should update the docs and did so if necessary:
  • Public contracts
    • Any modifications of public contracts comply with the Evolution of Public Contracts policy.
    • provided a migration guide for breaking changes if possible

Stylistic guide (mandatory)