Skip to content

Commit

Permalink
update PR templates
Browse files Browse the repository at this point in the history
  • Loading branch information
hturner committed Dec 11, 2024
1 parent 8ffa7c6 commit 6354121
Show file tree
Hide file tree
Showing 3 changed files with 72 additions and 40 deletions.
40 changes: 0 additions & 40 deletions .github/PULL_REQUEST_TEMPLATE.md

This file was deleted.

40 changes: 40 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/add_new_chapter.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
<!--
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.
-->
### Summary

<!-- Describe the problem you're trying to fix in this pull request. -->

*Lorem ipsum dolor sit amet, consectetur adipiscing.*

<!-- 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.
For simple PRs, you can delete this list. -->

- [ ] *Lorem ipsum dolor sit amet, consectetur adipiscing.*
- [ ] *Lorem ipsum dolor sit amet, consectetur adipiscing.*

<!-- 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". -->

Fixes #<NUM>

### Checklist for adding a new chapter or chapters

<!-- Fill the checkboxes to confirm you have followed all these steps. -->

- [ ] Have you updated the [Quick start to the guide](https://contributor.r-project.org/rdevguide/introduction.html#quick-start-to-the-guide) accordingly?
- [ ] Have you updated the `chapters` field of `_quarto.yml`? This determines the chapter ordering.
- [ ] Have you named the new `.qmd` files using lower case, with words separated by `_` if required?

### What should a reviewer concentrate their feedback on?

<!-- List any specific aspects for the reviewers to give feedback on, else leave the last bullet -->

- [ ] *Lorem ipsum dolor sit amet, consectetur adipiscing.*
- [ ] Everything looks ok?

### Acknowledging contributors

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).

- [ ] Please add @<github-username> for <contribution>. Please add @<other-github-username> for <contribution-1>, <contribution-2>.
- [ ] **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).
32 changes: 32 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/general_pull_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
<!--
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.
-->
### Summary

<!-- Describe the problem you're trying to fix in this pull request. -->

*Lorem ipsum dolor sit amet, consectetur adipiscing.*

<!-- 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.
For simple PRs, you can delete this list. -->

- [ ] *Lorem ipsum dolor sit amet, consectetur adipiscing.*
- [ ] *Lorem ipsum dolor sit amet, consectetur adipiscing.*

<!-- 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". -->

Fixes #<NUM>

### What should a reviewer concentrate their feedback on?

<!-- List any specific aspects for the reviewers to give feedback on, else leave the last bullet -->

- [ ] *Lorem ipsum dolor sit amet, consectetur adipiscing.*
- [ ] Everything looks ok?

### Acknowledging contributors

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).

- [ ] Please add @<github-username> for <contribution>. Please add @<other-github-username> for <contribution-1>, <contribution-2>.
- [ ] **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 comments on commit 6354121

Please sign in to comment.