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 #2152 update install instructions #2171

Merged
merged 1 commit into from
Oct 18, 2023
Merged

Conversation

ddsjoberg
Copy link
Collaborator

@ddsjoberg ddsjoberg commented Oct 18, 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 Shorten dev version install instructions #2151 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 (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 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!

@ddsjoberg ddsjoberg requested a review from bms63 October 18, 2023 16:42
@github-actions
Copy link

Code Coverage

Package Line Rate Health
admiral 98%
Summary 98% (4404 / 4473)

Copy link
Collaborator

@bms63 bms63 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we need to update the DESCRIPTION file with remotes so they get the latest and greatest from the helper packages?

@ddsjoberg
Copy link
Collaborator Author

do we need to update the DESCRIPTION file with remotes so they get the latest and greatest from the helper packages?

@bms63 if we make an update that depends on a dev version of the helper packages, then we should add Remotes: to the DESCRIPTION. Otherwise, we should just keep it as is.

@bms63 bms63 merged commit 4a65b39 into main Oct 18, 2023
21 checks passed
@bms63 bms63 deleted the 2151_readme-install-update@main branch October 18, 2023 20:05
@bundfussr
Copy link
Collaborator

do we need to update the DESCRIPTION file with remotes so they get the latest and greatest from the helper packages?

@bms63 if we make an update that depends on a dev version of the helper packages, then we should add Remotes: to the DESCRIPTION. Otherwise, we should just keep it as is.

Could we document this somewhere?
Would it harm to add Remotes: even if currently the devel version does not depend on devel versions of dependencies? Adding and removing Remotes: looks cumbersome to me and most likely we will forget it.

@ddsjoberg
Copy link
Collaborator Author

We'll never forget to add Remotes: when it's needed because our tests should fail when there is a breaking change in an upstream package.

We'll never forget to remove it, because CRAN will reject us if we submit with a Remotes: in the DESCRIPTION

@bms63
Copy link
Collaborator

bms63 commented Oct 19, 2023

I'll make a note to update in the prog docs - as none of us were aware of this Remotes stuff until you came along Daniel.

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.

Shorten dev version install instructions
3 participants