Skip to content

Commit 55a61a8

Browse files
authored
Merge pull request #2138 from mccode-dev/willend-patch-7-1
Revise PR template for clearer checklist instructions
2 parents 56e25e0 + d07f9b3 commit 55a61a8

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

docs/pull_request_template.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,16 @@
11
### Free-form text area
22
_Please describe what your PR is adding in terms of features or bugfixes:_
33

4+
Underline that only _relevant parts_ of the checklist needs to be filled in.
5+
46
--------------
57
### Development OS / boundary conditions
68
_Please describe what OS you developed and tested your additions on, and if any special dependencies are required:_
79

10+
811
--------------
912
# PR Checklist for contributing to McStas/McXtrace
10-
## For a coherent and useful contribution to McStas/McXtrace, please fill in and follow the checklists:
13+
## For a coherent and useful contribution to McStas/McXtrace, please fill in _relevant parts_ of the checklist:
1114
* ### My contribution includes patches to an **existing component** file
1215
* [ ] I have used the `mcdoc` utility and **rendered** a reasonable documentation page for the component (please attach as screenshot in comments!)
1316
* [ ] I have ensured that basic use of the component is OK (e.g. an instrument using it compiles?)
@@ -43,7 +46,7 @@ _Please describe what OS you developed and tested your additions on, and if any
4346
* [ ] I have indicated the issue number here:
4447
* [ ] I have added documentation for the fix and possible side effects
4548
* ### My contribution contains something else
46-
* [ ] Explanation is added in free form text above or below the checklist
49+
* [x] Explanation is added in free form text above or below the checklist
4750

4851
--------------
4952

0 commit comments

Comments
 (0)