Skip to content

Commit a98404a

Browse files
committed
refactor the task list
1 parent 5b8c4d8 commit a98404a

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,20 @@ Please keep in mind that lesson maintainers are volunteers and it may be some ti
55

66
* * *
77

8-
## Tasks
8+
## Before you start
99

1010
- [ ] Read [CONTRIBUTING.md](https://github.com/ESMValGroup/tutorial/blob/master/CONTRIBUTING.md).
11-
- [ ] Create an [issue](https://github.com/ESMValGroup/tutorial/issues) to discuss what you are going to do.
11+
- [ ] Create an [issue](https://github.com/ESMValGroup/tutorial/issues) to discuss your idea. This allows your contributions to be incorporated into the tutorial.
12+
13+
## Tasks
14+
1215
- [ ] Give this pull request a descriptive title.
13-
- [ ] If you are contributing to the 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.
14-
- [ ] Preferably Codacy code quality checks pass. However, a few remaining hard to solve Codacy issues are still acceptable. Status can be seen below your pull request. If there is an error, click the link to find out why. If you suspect Codacy may be wrong, please ask by commenting.
16+
- [ ] 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.
17+
- [ ] 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.
18+
- [ ] Preferably Codacy checks pass. Status can be seen below your pull request. If there is an error, click the link to find out why.
1519
- [ ] 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.
1620
- [ ] All code instructions have been tested.
1721

18-
## More tasks for a new episode
19-
20-
- [ ] Follow `Lesson organization` in [CONTRIBUTING.md](https://github.com/ESMValGroup/tutorial/blob/master/CONTRIBUTING.md).
21-
- [ ] Follow `Lesson formatting` in [CONTRIBUTING.md](https://github.com/ESMValGroup/tutorial/blob/master/CONTRIBUTING.md).
22-
2322
If you need help with any of the tasks above, please do not hesitate to ask by commenting in the issue or pull request.
2423

2524
* * *

0 commit comments

Comments
 (0)