First off, thanks for taking the time to contribute!
All types of contributions are encouraged and valued. See the Table of contents for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved.
This project is released with a Contributor Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to nicolas.casajus@fondationbiodiversite.fr.
We use the Tidyverse style guide for writing R code. Functions are documented with the roxygen2 syntax. rwosstarter uses the lower_snake_case.
If you want to contribute by commiting changes, please try to use the Conventional commits specification.
Before you ask a question, it is best to search for existing Issues that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue.
If you then still feel the need to ask a question and need clarification, we recommend the following:
sessionInfo()).We will then take care of the issue as soon as possible.
A good bug report shouldn’t leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
rwosstarter.We use GitHub Issues to track bugs and errors. If you run into an issue with the project:
We will then take care of the issue as soon as possible.
rwosstarter.Feature requests are tracked as GitHub Issues.
rwosstarter users.We will then take care of the issue as soon as possible.
We use the GitHub flow to collaborate on this project:
git clone fork-url (replace fork-url by the URL of your fork). Alternatively, open RStudio IDE and create a New Project from Version Control.git checkout -b branch-name (replace branch-name by the name of your new branch).git add) and commit (git commit) your changes as often as necessarygit push origin branch-name.We will then review the PR as soon as possible.
If you want to contribute by improving the README, please edit the README.Rmd (not the README.md). Do not forget to update the README.md by running:
rmarkdown::render("README.Rmd")If you want to contribute by editing an existing vignette, just edit the corresponding Rmd file stored in the vignettes/ folder.
If you want to contribute by adding a new vignette, create a new Rmd in the vignettes/ folder and add the following header:
---
title: "Vignette Title"
output: rmarkdown::html_vignette
vignette: >
%\VignetteIndexEntry{Vignette Title}
%\VignetteEngine{knitr::rmarkdown}
%\VignetteEncoding{UTF-8}
---If you use a new external dependency, do not forget to add it in the DESCRIPTION file under the section Suggests (only if this package is not already listed under the tag Imports).
Check the integrity of the package with:
devtools::check()If you want to contribute by improving the documentation of a function, open the corresponding file in the R/ folder and edit lines starting with #' (roxygen2 syntax).
Update the documentation (Rd files in the man/ folder) by running:
devtools::document()If you use a new external dependency in the example section, do not forget to add it in the DESCRIPTION file under the section Imports (only if this package is not already listed).
Check the integrity of the package with:
devtools::check()If you want to contribute by improving the code of a function, open and edit the corresponding file in the R/ folder.
Check the integrity of the package with:
devtools::check()Do not forget to adapt the unit tests for the function by editing the corresponding file stored in the tests/testthat/ folder. We use the package testthat to implement unit tests.
Check your tests by running:
devtools::test()If you want to contribute by submitting a new feature, please follow this workflow:
R file in the folder R/.DESCRIPTION file.devtools::document().R file in the folder tests/testthat/.devtools::check().