Skip to content

Commit a9d4a00

Browse files
JaeAeichuniqueg
andauthored
chore: update pull request template (#58)
Co-authored-by: Alex Kanitz <[email protected]>
1 parent e8c1e16 commit a9d4a00

File tree

3 files changed

+25
-46
lines changed

3 files changed

+25
-46
lines changed

PULL_REQUEST_TEMPLATE.md

Lines changed: 5 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -26,28 +26,11 @@ Generally, **PRs are only reviewed when all boxes are ticked off and all
2626
automated checks pass** (use the comment section below if you believe that
2727
your PR is ready to be merged even though not all boxes were ticked off). -->
2828

29-
- [ ] My code follows the [contributing guidelines][contributing-guidelines] of this
30-
project, including, in particular, with regard to any style guidelines
31-
- [ ] The title of my PR complies with the [Conventional Commits
32-
specification][conv-commits]; in particular, it clearly indicates
33-
that a change is a breaking change
34-
- [ ] I acknowledge that all my commits will be squashed into a single commit,
35-
using the PR title as the commit message
36-
- [ ] I have performed a self-review of my own code
37-
- [ ] I have commented my code in hard-to-understand areas
38-
- [ ] I have updated the user-facing documentation to describe any new or
39-
changed behavior
40-
- [ ] I have added type annotations for all function/class/method interfaces
41-
or updated existing ones (only for Python, TypeScript, etc.)
42-
- [ ] I have provided appropriate documentation ([Google-style Python
43-
docstrings][py-doc-google]) for all packages/modules/functions/classes/
44-
methods or updated existing ones
45-
- [ ] My changes generate no new warnings
46-
- [ ] I have added tests that prove my fix is effective or that my feature
47-
works
48-
- [ ] New and existing unit tests pass locally with my changes
49-
- [ ] I have not reduced the existing code coverage
50-
29+
1. [] My code follows the [contributing guidelines][contributing-guidelines]
30+
and I acknowledge that all my commits will be squashed into a single commit
31+
using the PR title as the commit message
32+
2. [] I have performed a self-review of my own code and updated the user-facing
33+
documentation to describe any new or changed behavior
5134

5235
#### Comments
5336

{{ cookiecutter.project_name_dashed }}/.pre-commit-config.yaml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,10 @@ repos:
2929
- mdformat-config
3030
- mdformat-black
3131
- mdformat-frontmatter
32-
args: [--wrap=80]
32+
- mdformat-gfm
33+
args:
34+
- --wrap=80
35+
- --number=false
3336
- repo: https://github.com/adrienverge/yamllint.git
3437
rev: v1.35.1
3538
hooks:

{{ cookiecutter.project_name_dashed }}/PULL_REQUEST_TEMPLATE.md

Lines changed: 16 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -29,33 +29,27 @@ ready for review. Please do not forget to double check the list after you have
2929
modified your PR, e.g., if you have added commits to address reviewer
3030
comments or to fix failing automated checks. **Please check items also if they
3131
do not apply to your change**, e.g., if your change does not require an update
32-
of the user-facing documentation, still check the box.
32+
of the user-facing documentation, still check the box!
3333
3434
Generally, **PRs are only reviewed when ALL BOXES are ticked off and all
3535
automated checks pass** (use the comment section below if you believe that
3636
your PR is ready to be merged even though not all boxes were ticked off). -->
3737

38-
- \[ \] My code follows the [contributing guidelines][contributing-guidelines]
39-
of this project, including, in particular, with regard to any style guidelines
40-
- \[ \] The title of my PR complies with the
41-
[Conventional Commits specification][conv-commits]; in particular, it clearly
42-
indicates that a change is a breaking change
43-
- \[ \] I acknowledge that all my commits will be squashed into a single commit,
44-
using the PR title as the commit message
45-
- \[ \] I have performed a self-review of my own code
46-
- \[ \] I have commented my code in hard-to-understand areas
47-
- \[ \] I have updated the user-facing documentation to describe any new or
48-
changed behavior
49-
- \[ \] I have added type annotations for all function/class/method interfaces
50-
or updated existing ones (only for Python, TypeScript, etc.)
51-
- \[ \] I have provided appropriate documentation
52-
([Google-style Python docstrings][py-doc-google]) for all
53-
packages/modules/functions/classes/methods or updated existing ones
54-
- \[ \] My changes generate no new warnings
55-
- \[ \] I have added tests that prove my fix is effective or that my feature
56-
works
57-
- \[ \] New and existing unit tests pass locally with my changes
58-
- \[ \] I have not reduced the existing code coverage
38+
1. [] My code follows the [contributing guidelines][contributing-guidelines]
39+
and I acknowledge that all my commits will be squashed into a single commit
40+
using the PR title as the commit message
41+
2. [] I have performed a self-review of my own code
42+
3. [] I have updated any relevant user- developer- and or administrator-facing
43+
documentation to describe any new or changed behavior
44+
4. [] I have added or updated docstrings in the style adopted by the project for
45+
all relevant packages/modules/functions/classes/methods or updated existing ones
46+
5. [] I have added type annotations for all function/class/method interfaces or
47+
updated existing ones
48+
6. [] I have added tests that prove my fix is effective or that my feature
49+
works
50+
7. [] I have not reduced the existing code coverage
51+
8. [] **I have ticked off all items in this checklist because leaving any unchecked
52+
boxes means the PR is not ready for review**
5953

6054
#### Comments
6155

@@ -68,5 +62,4 @@ in that case, it is a prerequisite that all commits follow the Conventional
6862
Commits specification). -->
6963

7064
[contributing-guidelines]: https://elixir-cloud-aai.github.io/guides/guide-contributor/workflow/
71-
[conv-commits]: https://www.conventionalcommits.org/en
7265
[py-doc-google]: https://google.github.io/styleguide/pyguide.html

0 commit comments

Comments
 (0)