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 main
branch until you have checked off each task.
styler::style_file()
to style R and Rmd filesinst/cheatsheet/admiral_cheatsheet.pptx
and re-upload a PDF and a PNG version of it to the same folder. (The PNG version can be created by taking a screenshot of the PDF version.)devtools::document()
so all .Rd
files in the man
folder and the NAMESPACE
file in the project root are updated appropriatelyNEWS.md
under the header # admiral (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). A Developer Notes section is available in NEWS.md
for tracking developer-facing issues. pkgdown::build_site()
and check that all affected examples are displayed correctly and that all new functions occur on the "Reference" page. lintr::lint_package()
R CMD check
locally and address all errors and warnings - devtools::check()
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.