Skip to content

Closes #103: Update pull_request_template.md#104

Merged
manciniedoardo merged 1 commit intomainfrom
103_pr_checklist_update
Mar 5, 2026
Merged

Closes #103: Update pull_request_template.md#104
manciniedoardo merged 1 commit intomainfrom
103_pr_checklist_update

Conversation

@manciniedoardo
Copy link
Copy Markdown
Collaborator

@manciniedoardo manciniedoardo commented Mar 5, 2026

Thank you for your Pull Request! We have developed this task checklist from the Development Process Guide to help with the final steps of the process. Completing the below tasks helps to ensure our reviewers can maximize their time on your code as well as making sure the admiral family codebase remains robust and consistent.

Please check off each taskbox as an acknowledgment that you completed the task or check off that it is not relevant to your Pull Request. This checklist is part of the Github Action workflows and the Pull Request will not be merged into the main branch until you have checked off each task.

  • Place Closes #<insert_issue_number> into the beginning of your Pull Request Title (Use Edit button in top-right if you need to update)
  • Code is formatted according to the tidyverse style guide. Run styler::style_file() to style R and Rmd files
  • Updated relevant unit tests or have written new unit tests, which should consider realistic data scenarios and edge cases, e.g. empty datasets, errors, boundary cases etc. - See Unit Test Guide
  • If you removed/replaced any function and/or function parameters, did you fully follow the deprecation guidance?
  • Update to all relevant roxygen headers and examples, including keywords and families. Refer to the categorization of functions to tag appropriate keyword/family.
  • Run devtools::document() so all .Rd files in the man folder and the NAMESPACE file in the project root are updated appropriately
  • Address any updates needed for vignettes and/or templates
  • Update NEWS.md under the header # admiral<ext> (development version) if the changes pertain to a user-facing function (i.e. it has an @export tag) or documentation aimed at users (rather than developers)
  • Build site pkgdown::build_site() and check that all affected examples are displayed correctly and that all new functions occur on the Reference page.
  • Address or fix all lintr warnings and errors - lintr::lint_package()
  • Run R CMD check locally and address all errors and warnings - devtools::check()
  • Link the issue in the Development Section on the right hand side.
  • Address all merge conflicts and resolve appropriately
  • Pat yourself on the back for a job well done! Much love to your accomplishment!

@manciniedoardo manciniedoardo requested a review from bundfussr March 5, 2026 13:21
@manciniedoardo manciniedoardo self-assigned this Mar 5, 2026
@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 5, 2026

Code Coverage

Package Line Rate Health
admiraltemplate 100%
Summary 100% (3 / 3)

@manciniedoardo manciniedoardo merged commit 18e08ef into main Mar 5, 2026
15 checks passed
@manciniedoardo manciniedoardo deleted the 103_pr_checklist_update branch March 5, 2026 14:58
@manciniedoardo manciniedoardo linked an issue Mar 11, 2026 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update PR checklist to add note about how to generate PR website

2 participants