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 #1839 dummy function created #2474

Closed
wants to merge 3 commits into from
Closed

Conversation

Siddhesh2097
Copy link

@Siddhesh2097 Siddhesh2097 commented Jul 4, 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 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?
  • Review the Cheat Sheet. Make any required updates to it by editing the file inst/cheatsheet/admiral_cheatsheet.pptx and re-upload a PDF version of it to the same folder.
  • 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). A Developer Notes section is available in NEWS.md for tracking developer-facing issues.
  • 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!

@Siddhesh2097 Siddhesh2097 linked an issue Jul 4, 2024 that may be closed by this pull request
Copy link

github-actions bot commented Jul 4, 2024

Code Coverage

Package Line Rate Health
admiral 96%
Summary 96% (4899 / 5098)

@manciniedoardo
Copy link
Collaborator

Great job @Siddhesh2097 - looks almost perfect, just two outstanding tasks:

  • Add "onboarding" to inst/WORDLIST so that spellcheck passes
    image

  • Run roxygen2::roxygenize('.', roclets = c('rd', 'collate', 'namespace')) so that man check passes
    image

@manciniedoardo
Copy link
Collaborator

@Siddhesh2097 looks good now! If you check every item in the tasklist then the final check should pass as well, then you are good to go!

@Siddhesh2097 Siddhesh2097 marked this pull request as ready for review July 8, 2024 08:53
@Siddhesh2097
Copy link
Author

Thank You @manciniedoardo. I have checked all items and the final check has passed. I clicked on Ready for Review. Can you tell me the next step, whether I need to close this issue or it will done by you.

@manciniedoardo
Copy link
Collaborator

@Siddhesh2097 all good now - i will close this PR now and you can start working on admiralmetabolic!

@bms63
Copy link
Collaborator

bms63 commented Jul 8, 2024

@Siddhesh2097 can I add you to the admiral community team? We ping this team occasionally on admiral developments? It is pretty low engagement ( a couple pings a month at most)

@Siddhesh2097
Copy link
Author

@bms63 Sure, please add me

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.

DUMMY ISSUE FOR ONBOARDING
3 participants