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 #84 readded staged deps file and fixed linter check #85

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

manciniedoardo
Copy link
Collaborator

@manciniedoardo manciniedoardo commented Jul 19, 2024

Closes #84

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!

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.

I have a feeling this needs to be added to .Rbuildignore

Also - do we really need this when we can just advise them to use Remotes? Our ecosystem is pretty basic compared to NEST which I think this originally came from.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Should we rename it to staged_dependencies.yaml?

Then the same extension as in admiral and .Rbuildignore is used.

@bundfussr
Copy link
Collaborator

Also - do we really need this when we can just advise them to use Remotes? Our ecosystem is pretty basic compared to NEST which I think this originally came from.

@bms63 , at the moment staged_dependencies.yaml is required by the lintr workflow (see pharmaverse/admiralpeds#76).

@bms63
Copy link
Collaborator

bms63 commented Aug 19, 2024

Also - do we really need this when we can just advise them to use Remotes? Our ecosystem is pretty basic compared to NEST which I think this originally came from.

@bms63 , at the moment staged_dependencies.yaml is required by the lintr workflow (see pharmaverse/admiralpeds#76).

okay sounds goods. I thought we had moved on from it but was mistaken.

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.

staged_dependencies.yaml needed
4 participants