Contributing to BacDiveR

This outlines how to propose a change to BacDiveR. Because this project should be to developed according to the needs of BacDive users, please in particular feel free to up- or down-vote existing issues, pull requests or comments. Thumbs-up and -down reactions will inform which issues to prioritise.

Improving texts

Small typos or grammatical errors in documentation may be edited directly using the GitHub web interface, so long as the changes are made in the source file.

  • YES: you edit a roxygen comment in an .R file below R/ or any .Rmd file.
  • NO: you edit an .Rd file below man/.

When in doubt, please proceed with:

Filing issues (also see the ISSUE_TEMPLATE.md)

Please don’t hesitate to open an issue if you:

a) want to ask a question,

a) suggest a new feature,

a) found a bug. Illustrating it with a minimal, reproducible example is extremely helpful for fixing it ;-)

a) in other cases, such as wanting to discuss sending a substantial pull request.

Please spend a few minutes searching the existing issues (also the closed ones), though. What you want to write might have been already ;-)

Sending pull requests (also see the PULL_REQUEST_TEMPLATE.md)

Contributions through pull requests are welcome, and will be replied to within 1 or 2 (non-holi)days.

  • We recommend that you create a Git branch for each PR, preferably with an issue number prepended to the branch name.
  • New code should follow RStudio’s style guide. Select code & press Shift+CTRL/CMD+A (or go to the “Code Tools” menu > “Reformat Code”).
  • We use roxygen2, with Markdown syntax, for documentation.
  • We use testthat. Contributions with test cases included are easier to accept.