Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
23 lines (12 loc) · 2.23 KB

CONTRIBUTING.md

File metadata and controls

23 lines (12 loc) · 2.23 KB

Contributions

Contributions to fst 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.

  1. Contributions can be submitted as a pull request on GitHub by forking or cloning the fst repository, making changes and submitting the pull request.

  2. 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.

  3. Pull requests that involve code in the 3rd party libraries LZ4, ZSTD or fstlib (located under src/fstcore) will not be accepted. These libraries are used as-is and any issues can be reported at their respective GitHub repositories.

  4. All contributions must be submitted consistent with the package license (AGPL-3).

  5. Contributions in the code (not documentation) that consist of more than 1000 characters (excluding spaces) need to be noted in the Authors@R field in the DESCRIPTION file. Just follow the format of the existing entries to add your name (and, optionally, email address).

  6. This package 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.

  7. Please run R CMD BUILD fst and R CMD CHECK fst_VERSION.tar.gz before submitting the pull request to check for any errors.

  8. Changes requiring a new package dependency should be discussed on the GitHub issues page before submitting a pull request.

Any questions you have can be opened as GitHub issues or directed to markklik (at) gmail.com.