This outlines how to propose a change to BacDiveR. Because this project should be 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.
Small typos or grammatical errors in documentation may be edited directly using the GitHub web interface, so long as the changes are made in a source file.
.R
file below R/
or any .Rmd
file..Rd
file below man/
.When in doubt, please proceed with:
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 substantial changes before sending a 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 ;-)
PULL_REQUEST_TEMPLATE.md
)Contributions through pull requests are welcome, and will be replied to within 1 or 2 (non-holi)days. Please:
master
branch and with an issue number prepended to your branch's name.styler::style_pkg()
. Using RStudio's
built-in Shift
+Ctrl/Cmd
+A
is also fine ("Code Tools" menu > "Reformat Code").devtools::document()
in case you modified any function documentation
within a #'
-denoted roxygen2
block and commit any .Rd
file changes to your PR branch.Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.