Closes #61: moved package ext guidance to admiraldev and linked to it #62
Conversation
|
PR to be merged only once corresponding admiraldev PR is live (link in README will be broken until then) and also version update PR too. |
|
NEWS.md
Outdated
|
|
||
| # Updates to site | ||
|
|
||
| - Package Extension guidance on in the front page was updated and moved to [this location](https://pharmaverse.github.io/admiraldev/main/articles/package_extensions.html) in `{admiraldev}`, and a link was added to point to the new location (#61). |
There was a problem hiding this comment.
we usually use the devel version of the site as default for admiraldev - so use this in the link. as it was important we always see the very latest developer guidance
| 7. It is important that the `{admiral}` family of packages keep to a similar release schedule and cadence, in order to ease adoption by our users and to give clear expectations. The `{admiral}` core package cadence of releases is one every quarter on a fixed schedule (every first Monday of the last month of a quarter - March, June, September, December). The core package will set the release schedule for the package extensions to follow, i.e. once `{admiral}` releases we'd expect package extension releases targeted within a 2 week window. These releases are communicated via our Slack channel as well as at our quarterly user community meetings. | ||
| 8. Once you are happy your package extension has been well tested and is at a sufficient state then make a submission to CRAN. The technical lead should be named as maintainer. After the CRAN release, you should advertise this via Slack & LinkedIn. | ||
| 9. Plan any future further enhancements and make issues. When your team feels ready you can open up to development contributions for these from the wider community - see `r dyn_link("this page.", admiral_homepage, "CONTRIBUTING.html#type-1-contribution-with-code")`. Please use the _“good first issue”_ (ideal for new starters) & _“help wanted”_ (ideal for more experienced contributors) issue labels. | ||
| For detailed information regarding the ethos of `{admiral}` package extensions and how to decide if you should set your own one up, please see our [Package Extension Guidance](https://pharmaverse.github.io/admiraldev/main/articles/package_extensions.html). You will also find details about team setup, suggested workflow and lessons learned from past package extensions. |
There was a problem hiding this comment.
With the adoption of GitHub Flow I believe we can drop the main devel stuff and just link to the generic site.
There was a problem hiding this comment.
yes makes sense - more important for users to be able to switch to different release versions on the site nowadays than devel vs main
|
I'm unclear what we need to update here with github flow and website updates. Perhaps @manciniedoardo when you return we could get this one completed. |
|
@bms63 I believe this should be good to go now (not sure what the checks are failing for though) as this PR was just to remove the package ext guidance from the readme of this repo and move it to a page on admiraldev. |
news file wasn't formatted properly. I updated and good to |
Closes #61
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
develbranch until you have checked off each task.styler::style_file()to style R and Rmd filesdevtools::document()so all.Rdfiles in themanfolder and theNAMESPACEfile in the project root are updated appropriatelyNEWS.mdif the changes pertain to a user-facing function (i.e. it has an@exporttag) or documentation aimed at users (rather than developers)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 checklocally and address all errors and warnings -devtools::check()