add a template for pull request

[SarahAlidoost]

It adds a PR template containing a list of tasks. It closes #18

[JaroCamphuijsen]

When I ran the PR template through a markdownlint tool I got:

these comments

21 - MD012 Multiple consecutive blank lines [Expected: 1; Actual: 2]
9 - MD030 Spaces after list markers [Expected: 1; Actual: 3]
10 - MD030 Spaces after list markers [Expected: 1; Actual: 3]
11 - MD030 Spaces after list markers [Expected: 1; Actual: 3]
12 - MD030 Spaces after list markers [Expected: 1; Actual: 3]
13 - MD030 Spaces after list markers [Expected: 1; Actual: 3]
14 - MD030 Spaces after list markers [Expected: 1; Actual: 3]
18 - MD030 Spaces after list markers [Expected: 1; Actual: 3]
19 - MD030 Spaces after list markers [Expected: 1; Actual: 3]
7 - MD036 Emphasis used instead of a heading [Context: "Tasks"]

[JaroCamphuijsen]

Looks good to me. What do you think @ledm , let's merge?

[ledm]

Looks good to me, only very minor comments. Nice work.

[ledm]

We probably want to add a list of bullet points for PRs containing new lessons too:

• Lesson is clearly explained, and includes questions and objectives.
• All code instructions have been tested.
• Lesson is a reasonable length. If its very long, please consider splitting it into two parts.
• Lesson ends with a summary of the key points.

Just some ideas, but think it would be useful.

[SarahAlidoost]

@JaroCamphuijsen @ledm Thanks for your comments.
There are not any recommendations regarding a linter and spell/grammar checker by Carpentry.

Regarding the linter tool for example, in vscode, a markdownlint can be installed as an extension. Users don’t need to run a command line for that. However, none-vscode users can install another tool via gem install mdl, and run mdl markdown_filename.
Regarding the spell/grammar checker, an option is Grammarly vscode extension. It depends on the editors that is used to develop lesson material. I will ask other colleagues for more suggestions.
The contributing.md is the best place to explain about both linter and spell/grammar checker. I update this PR template accordingly.

[SarahAlidoost]

Thanks a lot. Indeed very useful items. Please see below:

We probably want to add a list of bullet points for PRs containing new lessons too:

• Lesson is clearly explained, and includes questions and objectives.
  it will be covered in the lesson formatting section in contributing.md
• All code instructions have been tested.
  I added this item to the PR template.
• Lesson is a reasonable length. If its very long, please consider splitting it into two parts.
  it will be covered in the lesson formatting section in contributing.md
• Lesson ends with a summary of the key points.
  it will be covered in the lesson formatting section in contributing.md

Just some ideas, but think it would be useful.

For more info, please see https://carpentries.github.io/lesson-example/04-formatting/index.html

[ledm]

Do we want to make sure that these have been tested by the author and the reviewer?

Suggested change

	- [ ] All code instructions have been tested.
	- [ ] All code instructions have been tested by the PR author.
	- [ ] All code instructions have been tested by the reviewer.

[SarahAlidoost]

@ledm Thanks. I think that by default both reviewers and authors should check all the items provided in this template. So, we don't need to mention reviewer or author for this specific item.

[JaroCamphuijsen]

Apart from the tiny comment I left, I think this is ready to merge!

[SarahAlidoost]

@ledm @JaroCamphuijsen I think the template is ready, Shall we merge this PR?