From 3db71294839945828f3fba028bdf727cb9ff1970 Mon Sep 17 00:00:00 2001 From: Daniel Sjoberg Date: Thu, 8 Feb 2024 07:56:34 -0800 Subject: [PATCH] Update PULL_REQUEST_TEMPLATE.md --- .github/PULL_REQUEST_TEMPLATE.md | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index cd5e044a1..4889ac6c7 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,23 +1,28 @@ **What changes are proposed in this pull request?** +* Style this entry in a way that can be copied directly into `NEWS.md`. (#, @) +Provide more detail here as needed. -**Reference GitHub issue associated with pull request.** _e.g., 'closes #1'_ +**Reference GitHub issue associated with pull request.** _e.g., 'closes #'_ -------------------------------------------------------------------------------- +Pre-review Checklist (if item does not apply, mark is as complete) +- [ ] **All** GitHub Action workflows pass with a :white_check_mark: +- [ ] PR branch has pulled the most recent updates from master branch: `usethis::pr_merge_main()` +- [ ] If a bug was fixed, a unit test was added. +- [ ] Code coverage is suitable for any new functions/features (generally, 100% coverage for new code): `devtools::test_coverage()` +- [ ] Request a reviewer + Reviewer Checklist (if item does not apply, mark is as complete) -- [ ] Ensure all package dependencies are installed: `devtools::install_dev_deps()` -- [ ] PR branch has pulled the most recent updates from master branch: `usethis::pr_merge_main()` - [ ] If a bug was fixed, a unit test was added. - [ ] Run `pkgdown::build_site()`. Check the R console for errors, and review the rendered website. - [ ] Code coverage is suitable for any new functions/features: `devtools::test_coverage()` -- [ ] `usethis::use_spell_check()` runs with no spelling errors in documentation When the branch is ready to be merged: - [ ] Update `NEWS.md` with the changes from this pull request under the heading "`# cards (development version)`". If there is an issue associated with the pull request, reference it in parentheses at the end update (see `NEWS.md` for examples). -- [ ] Increment the version number using `usethis::use_version(which = "dev")` -- [ ] Run `usethis::use_spell_check()` again +- [ ] **All** GitHub Action workflows pass with a :white_check_mark: - [ ] Approve Pull Request -- [ ] Merge the PR. Please use "Squash and merge". +- [ ] Merge the PR. Please use "Squash and merge" or "Rebase and merge".