Skip to content

Latest commit

 

History

History
48 lines (28 loc) · 5.21 KB

CONTRIBUTING.md

File metadata and controls

48 lines (28 loc) · 5.21 KB
Raw

Contributing to epiverse-trace packages

There are lots of ways you can contribute to packages within the epiverse-trace organisation. All contributions are most welcome and only some of these require techical knowledge. If you have something to contribute but aren't sure how, please don't hesitate to log an issue or get in touch with Community Manager Diana by email to [email protected].

The below guidelines outline how to propose a change to epiverse-trace packages. We abide by the contibuting guidelines developed by the tidyverse. For more detailed info about contributing to this, and other epiverse-trace packages, please see the tidyverse development contributing guide.

Fixing typos

You can fix typos, spelling mistakes, or grammatical errors in the documentation directly using the GitHub web interface, as long as the changes are made in the source file. This generally means you'll need to edit roxygen2 comments in an .R, not a .Rd file. You can find the .R file that generates the .Rd by reading the comment in the first line.

Bigger changes

If you want to make a bigger change, it's a good idea to first file an issue and make sure someone from the team agrees that it’s needed. If you’ve found a bug, please file an issue that illustrates the bug with a minimal reprex. This will also help you write a unit test, if needed.

Pull request process

  • Fork the package and clone onto your computer. If you haven't done this before, we recommend using usethis::create_from_github("{{github_spec}}", fork = TRUE).
  • Install all development dependencies with devtools::install_dev_deps(), and then make sure the package passes R CMD check by running devtools::check(). If R CMD check doesn't pass cleanly, it's a good idea to ask for help before continuing.
  • Create a Git branch for your pull request (PR). We recommend using usethis::pr_init("brief-description-of-change").
  • Make your changes, commit to git, and then create a PR by running usethis::pr_push(), and following the prompts in your browser. The title of your PR should briefly describe the change. The body of your PR should contain Fixes #issue-number.
  • For user-facing changes, add a bullet to the top of NEWS.md (i.e. just below the first header). Follow the style described in https://style.tidyverse.org/news.html.

What happens after submitting a pull request?

PRs are reviewed by the team before they are merged. The review process begins after continuous integration automated checks, which can take some time. We do not expect contributors to familiarise themselves with all the automated checks in our GitHub actions, and are happy to support on this once a PR is made.

If possible, we recommend you run the automated checks on your local computer first for easier troubleshooting and a reduced cloud computing resource usage. Here is a summary of the main checks that are automatically performed and how they can be confirmed:

  • Load the package for Epiverse-customised versions of the checks: remotes::install_github("epiverse-trace/etdev").

  • Run lintr::lint_package() to check for programmatic and stylistic errors in code.

  • Run devtools::document() to regenerate the .Rd files if changes were made to documentation.

  • Run devtools::check() to make sure the package passes R CMD check (see previous section). You may prefer to run individual checks such as spelling::spell_check_test() to check spelling and testthat::test_package() to check that package tests are still passing before running this more comprehensive check.

Code style

  • New code should follow the tidyverse style guide. You can use the styler package to apply these styles, but please don't restyle code that has nothing to do with your PR.
  • We use roxygen2 for basic documentation, rmarkdown for vignettes and pkgdown for websites.
  • We use testthat for unit tests. Contributions with test cases included are easier to accept.

Use cases

We are always interested in hearing about how epiverse-trace packages are being applied. This helps inform future development priorities by identifying which features are the most used, and which parts of the project lack clarity or need improvement. If you have a use case which you would like to share with the wider community, please do let us know. You can post about it in the discussions board of the relevant repository or reach out through email. We're grateful for any way that you can spread the word. Whether that's citing epiverse-trace packages in your papers or telling your friends about a feature you found useful.

Code of Conduct

Please note that these packages are released with a Contributor Code of Conduct. By contributing to this project you agree to abide by its terms.