Skip to content

Commit 6354121

Browse files
hturnerhturner
committed
update PR templates
1 parent 8ffa7c6 commit 6354121

File tree

3 files changed

+72
-40
lines changed

3 files changed

+72
-40
lines changed

‎.github/PULL_REQUEST_TEMPLATE.md

-40
This file was deleted.

‎.github/PULL_REQUEST_TEMPLATE/add_new_chapter.md

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
<!--
2+
Please complete the following sections when you submit your pull request. You are encouraged to keep this top level comment box updated as you develop and respond to reviews. Note that text within html comment tags will not be rendered.
3+
-->
4+
### Summary
5+
6+
<!-- Describe the problem you're trying to fix in this pull request. -->
7+
8+
*Lorem ipsum dolor sit amet, consectetur adipiscing.*
9+
10+
<!-- For larger PRs, use bullets with checkboxes to list specific changes. Empty checkboxes indicate that the PR is still a work in progress and not yet ready for review.
11+
For simple PRs, you can delete this list. -->
12+
13+
- [ ] *Lorem ipsum dolor sit amet, consectetur adipiscing.*
14+
- [ ] *Lorem ipsum dolor sit amet, consectetur adipiscing.*
15+
16+
<!-- Please reference any related issue(s) and use fixes/close to automatically close them, if pertinent. For example: "Fixes #58", or "Addresses (but does not close) #238". -->
17+
18+
Fixes #<NUM>
19+
20+
### Checklist for adding a new chapter or chapters
21+
22+
<!-- Fill the checkboxes to confirm you have followed all these steps. -->
23+
24+
- [ ] Have you updated the [Quick start to the guide](https://contributor.r-project.org/rdevguide/introduction.html#quick-start-to-the-guide) accordingly?
25+
- [ ] Have you updated the `chapters` field of `_quarto.yml`? This determines the chapter ordering.
26+
- [ ] Have you named the new `.qmd` files using lower case, with words separated by `_` if required?
27+
28+
### What should a reviewer concentrate their feedback on?
29+
30+
<!-- List any specific aspects for the reviewers to give feedback on, else leave the last bullet -->
31+
32+
- [ ] *Lorem ipsum dolor sit amet, consectetur adipiscing.*
33+
- [ ] Everything looks ok?
34+
35+
### Acknowledging contributors
36+
37+
List any contributions that need adding to the [table of contributors](https://github.com/r-devel/rdevguide/blob/main/README.md#contributors-). Common contributions are `content` (adding to the guide), `doc` (e.g. README, wiki), `infra` (e.g. GitHub action), and `maintenance` (e.g. fixing links). See the full key to [Contribution Types](https://allcontributors.org/docs/en/emoji-key).
38+
39+
- [ ] Please add @<github-username> for <contribution>. Please add @<other-github-username> for <contribution-1>, <contribution-2>.
40+
- [ ] **For reviewers**: All relevant contributions have been added, including reviewers, mentors, contributors to the ideas/planning. See [how to acknowledge contributors](https://github.com/r-devel/rdevguide/blob/main/HOWTO-acknowledge-contributors.md).

‎.github/PULL_REQUEST_TEMPLATE/general_pull_request.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
<!--
2+
Please complete the following sections when you submit your pull request. You are encouraged to keep this top level comment box updated as you develop and respond to reviews. Note that text within html comment tags will not be rendered.
3+
-->
4+
### Summary
5+
6+
<!-- Describe the problem you're trying to fix in this pull request. -->
7+
8+
*Lorem ipsum dolor sit amet, consectetur adipiscing.*
9+
10+
<!-- For larger PRs, use bullets with checkboxes to list specific changes. Empty checkboxes indicate that the PR is still a work in progress and not yet ready for review.
11+
For simple PRs, you can delete this list. -->
12+
13+
- [ ] *Lorem ipsum dolor sit amet, consectetur adipiscing.*
14+
- [ ] *Lorem ipsum dolor sit amet, consectetur adipiscing.*
15+
16+
<!-- Please reference any related issue(s) and use fixes/close to automatically close them, if pertinent. For example: "Fixes #58", or "Addresses (but does not close) #238". -->
17+
18+
Fixes #<NUM>
19+
20+
### What should a reviewer concentrate their feedback on?
21+
22+
<!-- List any specific aspects for the reviewers to give feedback on, else leave the last bullet -->
23+
24+
- [ ] *Lorem ipsum dolor sit amet, consectetur adipiscing.*
25+
- [ ] Everything looks ok?
26+
27+
### Acknowledging contributors
28+
29+
List any contributions that need adding to the [table of contributors](https://github.com/r-devel/rdevguide/blob/main/README.md#contributors-). Common contributions are `content` (adding to the guide), `doc` (e.g. README, wiki), `infra` (e.g. GitHub action), and `maintenance` (e.g. fixing links). See the full key to [Contribution Types](https://allcontributors.org/docs/en/emoji-key).
30+
31+
- [ ] Please add @<github-username> for <contribution>. Please add @<other-github-username> for <contribution-1>, <contribution-2>.
32+
- [ ] **For reviewers**: All relevant contributions have been added, including reviewers, mentors, contributors to the ideas/planning. See [how to acknowledge contributors](https://github.com/r-devel/rdevguide/blob/main/HOWTO-acknowledge-contributors.md).

0 commit comments

Comments
 (0)