Skip to content

Commit 2710bfa

Browse files
committed
add a template for pull request
1 parent 522ccf2 commit 2710bfa

File tree

1 file changed

+22
-5
lines changed

1 file changed

+22
-5
lines changed

.github/PULL_REQUEST_TEMPLATE.md

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

3-
---
3+
Thanks for contributing!
4+
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.
5+
* * *
46

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.
7+
**Tasks**
68

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].
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 what you are going to do.
11+
- [ ] Give this pull request a descriptive title.
12+
- [ ] If you are contributing to the lesson materials, make sure the content does not have spelling or grammar errors.
13+
- [ ] Please use `markdownlinter` to check that your files do not contain errors.
14+
- [ ] Preview changes on your own machine before pushing them to GitHub by running `make docker-serve`.
815

9-
---
16+
New episode
17+
18+
- [ ] Follow `Lesson Organization` in [CONTRIBUTING.md](https://github.com/ESMValGroup/tutorial/blob/master/CONTRIBUTING.md).
19+
- [ ] Follow `Lesson Formatting` in [CONTRIBUTING.md](https://github.com/ESMValGroup/tutorial/blob/master/CONTRIBUTING.md).
20+
21+
22+
If you need help with any of the tasks above, please do not hesitate to ask by commenting in the issue or pull request.
23+
24+
* * *
25+
26+
Closes {Link to the corresponding issue}

0 commit comments

Comments
 (0)