@@ -29,33 +29,27 @@ ready for review. Please do not forget to double check the list after you have
29
29
modified your PR, e.g., if you have added commits to address reviewer
30
30
comments or to fix failing automated checks. **Please check items also if they
31
31
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!
33
33
34
34
Generally, **PRs are only reviewed when ALL BOXES are ticked off and all
35
35
automated checks pass** (use the comment section below if you believe that
36
36
your PR is ready to be merged even though not all boxes were ticked off). -->
37
37
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**
59
53
60
54
#### Comments
61
55
@@ -68,5 +62,4 @@ in that case, it is a prerequisite that all commits follow the Conventional
68
62
Commits specification). -->
69
63
70
64
[ contributing-guidelines ] : https://elixir-cloud-aai.github.io/guides/guide-contributor/workflow/
71
- [ conv-commits ] : https://www.conventionalcommits.org/en
72
65
[ py-doc-google ] : https://google.github.io/styleguide/pyguide.html
0 commit comments