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 #283 update description and news as post-release cleanup tasks #284

Merged
merged 3 commits into from
Jun 12, 2023

Conversation

zdz2101
Copy link
Collaborator

@zdz2101 zdz2101 commented Jun 12, 2023

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, 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 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 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!

@zdz2101 zdz2101 linked an issue Jun 12, 2023 that may be closed by this pull request
2 tasks
@github-actions
Copy link

github-actions bot commented Jun 12, 2023

Code Coverage

Package Line Rate Health
admiraldev 97%
Summary 97% (1138 / 1169)

@zdz2101 zdz2101 changed the base branch from main to devel June 12, 2023 19:48
@zdz2101 zdz2101 requested a review from bms63 June 12, 2023 20:05
@zdz2101 zdz2101 marked this pull request as ready for review June 12, 2023 20:05
@zdz2101
Copy link
Collaborator Author

zdz2101 commented Jun 12, 2023

This should also catch devel up to main @bms63

@bms63 bms63 merged commit 8af2f65 into devel Jun 12, 2023
19 checks passed
@bms63 bms63 deleted the 283_news_description_postrelease_tidying@devel branch June 12, 2023 20:24
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.

General Issue: Parts of Post-Release Tidying
2 participants