First of all, thank you for taking time to contribute to golem!
There are several ways to contribute to the package:
Spot typos and/or mistakes in the documentations
Feature requests or Bug Report
Contribute the code-base with new features or with bug fixes
For a simple typo, you can PR into the repo without opening an issue first. You can also only report the typo without doing a PR.
You’re welcome to fix the bug or implement the feature, but please don’t PR in the repo with features or bugs correction without opening an issue first so that we can discuss the feature / confirm the bug.
Fork the repo on your profile.
git clone your repo on your machine.
git clone https://github.com/YOURNAME/golem.git
git branch dev
Or use the Git panel from RStudio
Make the changes locally.
Be sure to have a
devtools::check() that return 0 errors, 0 warnings and 0 mistakes
If ever you have some errors, please specify it in your commit message / PR comment
PR the change into golem dev branch, not straight to master
In your PR message, please add the reference of the issue, and the content to be used in NEWS.md. Changes can be :
## New Functions,
## New features,
## Breaking changes,
## Bug fix,
## Bug fix,
## Internal changes
See https://github.com/ThinkR-open/golem/pull/149 for an example
Please style the files according to