NA
Source:CONTRIBUTING.md
Thanks for considering phytoclass for your latest project!
Pull requests are welcomed, please open an issue on github to get started.
Development Workflow
- identify integration test, vignette, or testthat test to work from.
- modify & test until passing
- edit
devtools::load_all()
- run your test||vignette
-
git commit
changes
Testing
-
./tests/integration/
includes user-contributed data and.qmd
files that use these data.- Running the tests is accomplished by rendering the
.qmd
files using quarto or RStudio.
- Running the tests is accomplished by rendering the
-
./tests/testthat/
is where unit tests will be placed, but none exist yet.
Pushing a Release
# 1. Open your package project in RStudio (clone from GitHub if needed)
# 2. Update NEWS.md with a summary of changes
# 3. Regenerate documentation
devtools::document()
# 4. Run all tests
devtools::test()
# 5. Check package with CRAN-level checks
devtools::check()
# 6. (Optional) Check on remote platforms
devtools::check_rhub()
devtools::check_win_devel()
# 7. Bump version (choose "patch", "minor", or "major")
usethis::use_version("patch")
# 8. Build package for CRAN submission
devtools::build()
# 9. Submit to CRAN
devtools::submit_cran()