Contributions to cregg are welcome from anyone and are best sent as pull requests on the GitHub repository. This page provides some instructions to potential contributors about how to add to the package.
Contributions can be submitted as a pull request on GitHub by forking or cloning the repo, making changes and submitting the pull request.
The project follows a consistent style guide across all of its packages. Please refer to this when editing package code.
Pull requests should involve only one commit per substantive change. This means if you change multiple files (e.g., code and documentation), these changes should be committed together. If you don’t know how to do this (e.g., you are making changes in the GitHub web interface) just submit anyway and the maintainer will clean things up.
All contributions must be submitted consistent with the package license (MIT).
Non-trivial contributions need to be noted in the Authors@R field in the DESCRIPTION. Just follow the format of the existing entries to add your name (and, optionally, email address). Substantial contributions should also be noted in inst/CITATION.
The project uses royxgen code and documentation markup, so changes should be made to roxygen comments in the source code .R files. If changes are made, roxygen needs to be run. The easiest way to do this is a command line call to: Rscript -e devtools::document(). Please resolve any roxygen errors before submitting a pull request.
Please run R CMD BUILD cregg and R CMD CHECK cregg_VERSION.tar.gz before submitting the pull request to check for any errors.
Some specific types of changes that you might make are:
Bug fixes. Great!
Documentation-only changes (e.g., to Rd files, README, vignettes). This is great! All contributions are welcome.
New functionality. This is fine, but should be discussed on the GitHub issues page before submitting a pull request.
Changes requiring a new package dependency should also be discussed on the GitHub issues page before submitting a pull request.
Message translations. These are very appreciated! The format is a pain, but if you’re doing this I’m assuming you’re already familiar with it.
Any questions you have can be opened as GitHub issues or directed to thosjleeper (at) gmail.com.