Contributing to elicitr • elicitr

Thank you for taking the time to contribute to our project. Please, read our Contributor Code of Conduct to help keep our community friendly and respectful and review this document before filing an issue or opening a PR.

Questions

If you have a question, please do not file an issue on GitHub but use other channels.

Issues

Please, before filing and issue check whether it already exists.

Before reporting a bug make sure you have the latest version of elicitr installed. It is very important to provide a minimal reproducible example. The example should only include code relevant to the problem, so please remove any lines of code not relevant to it.

Pull Requests

We follow a coding convention. Check out the code in this repository to see the style we use and refer to the tidyverse guidelines for a detailed description of coding conventions.

Before you open a PR it is important that all the following steps can be executed successfully (see the R Packages book for details):

Start a new R session
Load devtools with:
```
library(devtools)
```
Load the package with:
```
load_all()
```
Rebuild the documentation with:
```
document()
```
Rebuild the README file with:
```
build_readme()
```
Run R CMD check:
```
check()
```
Run spell check:
```
spell_check()
```
Lint the package:
```
lintr::lint_package()
```