Skip to content

Commit ba44db7

Browse files
authored
Merge pull request #19 from ESMValGroup/add_PR_template
add a template for pull request
2 parents 37752ac + 8f2f86b commit ba44db7

File tree

1 file changed

+21
-5
lines changed

1 file changed

+21
-5
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,25 @@
1-
Please delete this line and the text below before submitting your contribution.
1+
# Pull Request checklist
22

3-
---
3+
We appreciate your time and effort to improve the tutorial. Please keep in mind that lesson maintainers are volunteers and it may be some time before they can respond to your contribution.
44

5-
Thanks for contributing! If this contribution is for instructor training, please send an email to [email protected] with a link to this contribution so we can record your progress. You’ve completed your contribution step for instructor checkout just by submitting this contribution.
5+
* * *
66

7-
Please keep in mind that lesson maintainers are volunteers and it may be some time before they can respond to your contribution. Although not all contributions can be incorporated into the lesson materials, we appreciate your time and effort to improve the curriculum. If you have any questions about the lesson maintenance process or would like to volunteer your time as a contribution reviewer, please contact The Carpentries Team at [email protected].
7+
## Before you start
88

9-
---
9+
- [ ] Read [CONTRIBUTING.md](https://github.com/ESMValGroup/tutorial/blob/master/CONTRIBUTING.md).
10+
- [ ] Create an [issue](https://github.com/ESMValGroup/tutorial/issues) to discuss your idea. This allows your contributions to be incorporated into the tutorial.
11+
12+
## Tasks
13+
14+
- [ ] Give this pull request a descriptive title.
15+
- [ ] If you are contributing to existing lesson materials, please make sure the content conforms to the `Lesson development` section in [CONTRIBUTING.md](https://github.com/ESMValGroup/tutorial/blob/master/CONTRIBUTING.md) and does not contain any spelling or grammatical errors.
16+
- [ ] If you are making a new episode, please make sure the content conforms to the `Lesson organization` and `Lesson formatting` sections in [CONTRIBUTING.md](https://github.com/ESMValGroup/tutorial/blob/master/CONTRIBUTING.md) and does not contain any spelling or grammatical errors.
17+
- [ ] Preferably Codacy checks pass. Status can be seen below your pull request. If there is an error, click the link to find out why.
18+
- [ ] Preview changes on your machine before pushing them to GitHub by running `make serve`, alternatively `make docker-serve`. Please see the `Previewing your changes locally` section in [CONTRIBUTING.md](https://github.com/ESMValGroup/tutorial/blob/master/CONTRIBUTING.md) for installation instructions.
19+
- [ ] All code instructions have been tested.
20+
21+
If you need help with any of the tasks above, please do not hesitate to ask by commenting in the issue or pull request.
22+
23+
* * *
24+
25+
Closes {Link to the corresponding issue}

0 commit comments

Comments
 (0)