Skip to content

Commit b3a4d24

Browse files
committed
MAINT: Add Auto-comment bot to provide templates for PR review [skip ci]
1 parent 278fb84 commit b3a4d24

File tree

1 file changed

+77
-0
lines changed

1 file changed

+77
-0
lines changed

.github/auto-comment.yml

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
pullRequestOpened: |
2+
Thank your for raising your pull request.
3+
4+
Some of the *fMRIPRep* maintainers will review your changes as soon as time permits.
5+
I'm attaching below a *Review Checklist* for the reviewers, to copy and paste
6+
it in their review comment.
7+
8+
```markdown
9+
10+
## PR Review
11+
12+
*Please check off boxes as applicable, and elaborate in comments below. Your review is not limited to these topics, as described in the reviewer guide*
13+
14+
- [ ] As the reviewer I confirm that there are no conflicts of interest for me to review this work.
15+
16+
Please check what applies in the following aspects of the PR:
17+
18+
#### Code documentation
19+
20+
- [ ] New functions and modules are documented following the guidelines.
21+
- [ ] Existing code required amendments in documentation and has been updated.
22+
- [ ] Sufficient inline comments ensure readability by other contributors in the long term.
23+
24+
#### Documentation site
25+
26+
- [ ] The modifications to *fMRIPrep* in this PR **do not require extra documentation**. This is a common situation when a bug fix that does not change the code base substantially is submitted.
27+
- [ ] This PR requires documentation. The corresponding documentation will be submitted as an additional PR in the future.
28+
- [ ] This PR requires extra documentation, and will be included within this PR. Please check the boxes that apply best:
29+
- [ ] An existing feature is substantially modified, changing the interface and/or logic of a module.
30+
- [ ] A new feature is being added, therefore full documentation of it will be included
31+
- [ ] This PR addresses an error in existing documentation.
32+
- [ ] Yes, all expected sections of documentation were generated by the CI build, and look as expected
33+
34+
#### Tests
35+
36+
- [ ] The new functionalities in this PR are covered by the existing tests
37+
- [ ] New test batteries have been included with this PR
38+
39+
#### Data
40+
41+
- [ ] This PR does not require any additional data to be uploaded to OSF.
42+
- [ ] This PR requires additional data for tests.
43+
44+
#### Dependencies: smriprep
45+
46+
- [ ] This PR does not require any update on `smriprep`; or
47+
- [ ] `smriprep` has correctly been pinned.
48+
49+
#### Dependencies: niworkflows
50+
51+
- [ ] This PR does not require any update on `niworkflows`; or
52+
- [ ] `niworkflows` has correctly been pinned.
53+
54+
#### Dependencies: sdcflows
55+
56+
- [ ] This PR does not require any update on `sdcflows`; or
57+
- [ ] `sdcflows` has correctly been pinned.
58+
59+
#### Dependencies: Nipype
60+
61+
- [ ] This PR does not require any update on `nipype`; or
62+
- [ ] `nipype` has correctly been pinned.
63+
64+
#### Dependencies: other
65+
66+
- [ ] This PR does not require any update on other dependencies; or
67+
- [ ] other dependencies have correctly been pinned.
68+
69+
#### Reports generated within CI tests
70+
71+
- [ ] Yes, I have checked the reports of ds005 and they are not modified or the changes are as expected
72+
- [ ] Yes, I have checked the reports of ds054 and they are not modified or the changes are as expected
73+
- [ ] Yes, I have checked the reports of ds010 and they are not modified or the changes are as expected
74+
75+
### Review Comments (other than those left inline with the code)
76+
77+
```

0 commit comments

Comments
 (0)