Please open an issue instead of e-mailing the maintainer. E-mails will be a very low priority to answer.
git clone [email protected]:<yourgithubusername>/solrium.git
ropensci/solrium) by doing
git remote add upstream [email protected]:ropensci/solrium.git. Before making changes make sure to pull changes in from upstream by doing either
git fetch upstreamthen merge later or
git pull upstreamto fetch and merge in one step
To add tests, go to the folder
tests/testthat/. Tests are generally organized as individual files for each exported function from the package (that is, listed as an export in the
NAMESPACE file). If you are adding a new exported function, add a new test file. If you are changing an existing function, work in the tests file for that function, unless it doesn’t have tests, in which case make a new test file.
The book R packages book provides a chapter on testing in general. Do consult that first if you aren’t familiar with testing in R.
The easiest set up to run tests is from within an R session:
To test an individual test file
To run all tests
Or you can run from the CLI like
Rscript -e "devtools::test()"
In addition to changing the code, do make sure to udpate the documentation if applicable. The R packages book book has a chapter on documentation you should read if you aren’t familiar.
Make sure if you change what packages or even functions within packages are imported, most likely add the package to Imports in the DESCRIPTION file and list what functions are imported in the
Be very conservative about adding new dependencies.