Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closes #240 documentation and templates #247

Merged
merged 10 commits into from
Jul 31, 2024

Conversation

federicobaratin
Copy link
Collaborator

@federicobaratin federicobaratin commented Jul 19, 2024

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 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 devel 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 - 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.
  • 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 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 admiral 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 so that it closes after successful merging.
  • Address all merge conflicts and resolve appropriately.
  • Pat yourself on the back for a job well done! Much love to your accomplishment!

@federicobaratin federicobaratin added enhancement New feature or request final review Addressing comments from the final review of Admiral team labels Jul 19, 2024
@federicobaratin federicobaratin self-assigned this Jul 19, 2024
@federicobaratin federicobaratin changed the title 240 documentation and templates Closes #240 documentation and templates Jul 19, 2024
Copy link

github-actions bot commented Jul 31, 2024

Code Coverage

Package Line Rate Health
admiralvaccine 99%
Summary 99% (369 / 372)

@ahasoplakus ahasoplakus linked an issue Jul 31, 2024 that may be closed by this pull request
@ahasoplakus ahasoplakus merged commit ab7dac5 into main Jul 31, 2024
16 checks passed
@ahasoplakus ahasoplakus deleted the 240-Documentation-and-Templates branch July 31, 2024 11:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request final review Addressing comments from the final review of Admiral team
Projects
Status: In Review
Development

Successfully merging this pull request may close these issues.

Documentation & Templates: Make subject keys consistently flexible
2 participants