No matter your current skills, it’s possible to contribute to the
rgugik package. We appreciate any contribution no matter the amount.
If you’ve found a bug, please create a minimal reproducible example using the reprex package first. Spend some time trying to make it as minimal as possible, this will facilitate the task and speed up the entire process. Next, submit an issue on the Issues page.
You can fix typos, spelling mistakes, or grammatical errors in the documentation. We use roxygen2, so the documentation should be generated using
.R files, not by editing the
.Rd files directly.
If you want to make a greater change, it’s a good idea to file an issue first and make sure someone from the team agrees that it’s needed. We don’t want you to spend a bunch of time on something that we don’t think is a suitable idea.
Once accepted, you can follow the pull request process:
git clone https://github.com/kadyb/rgugik.git.
kadyb/rgugik) by doing
git remote add upstream https://github.com/kadyb/rgugik.git. Before making any changes, make sure to pull changes in from upstream by either doing
git fetch upstreamthen merge later, or
git pull upstreamto fetch and merge in one step.
We use testthat for unit tests. Contributions with test cases included are prioritized to accept.
Please make sure that your new code and documentation match the existing style. We use lintr for static code analysis (i.e., code style).
Questions are welcomed on the Issues page. Adding a reproducible example may make it easier for us to answer.