When contributing to this project, please first discuss the change you wish to make via issue before making a change and pull request. Please submit questions, bug reports, and requests in the issues tracker.

Note that we have a code of conduct, please follow it in all your interactions with the project.

If you plan to contribute, please read our pull request process.

Pull Request Process

  1. If you have large changes, please open an issue first to discuss.
  2. Fork the project and clone locally.
  3. Changes should be made to the develop branch. Do not modify the main branch.
  4. Documentation is generated by roxygen2. Please write documentation in code files and let it auto-generate documentation files. We use a recent version and write the documentation in markdown. The R Packages book by Hadley Wickham and Jennifer Bryan may help you.
  5. Write and test your code with goodpractice before submitting your change.
  6. Push to the origin repository.