Skip to contents

Contributing to rpaleoclim

Source: .github/CONTRIBUTING.md

rpaleoclim is free and open source (FOSS) software maintained in the interests of open science. Contributions of all types are welcome.

Bug reports

To report a bug or problem, please create a new issue at https://github.com/joeroe/rpaleoclim/issues. Please include as much information as possible and, if you can, a minimal reproducible example (“reprex”).

Suggestions

To suggest an new feature or improvement, please create a new issue at https://github.com/joeroe/rpaleoclim/issues.

Code

All contributions are welcome, but if possible please follow these conventions:

  • For R code, follow the tidyverse style guide
  • For documentation, use roxygen2
  • If you add new functionality, write unit tests for it with testthat
  • Run devtools::check() to build the package and run tests before making a pull request

Then follow the GitHub flow and make a pull request with your contributions.

Questions and comments

For any other questions or comments on this software, please feel free to email the maintainer at .