Skip to content

GitHub issue and PR templates

Jeremy Soller requested to merge ticki:master into master

Created by: ticki

Problem: The PRs tend to be very little descriptive and non-explaining without having to look at the diffs.

Solution: Introduce templates to encourage rich information about the changes, to increase quality of the issues and PR descriptions.

Changes introduced by this pull request:

  • Add a PR template. See Github's blog post. This template is to encourage non-small PRs to contain extra useful information about the changes.
  • Add an issue template, encouraging users to describe the reproduction steps and the expected behavior.

Drawbacks: This might reduce the number of micro PRs (~3 lines), since describing the changes is not a programmers favorite task. In order to combat this, we add a small message in the bottom stating that the description is unnecessary for smaller PRs.

TODOs: Possibly improvement to the fields.

Fixes: This does not fix any specific issues.

State: Ready.

Blocking/related: This is a part of the documentation effort going on. Related to #525 (closed).

Merge request reports