Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
SMITH committed Jan 12, 2022
1 parent a0b008c commit 3b5181d
Showing 1 changed file with 10 additions and 9 deletions.
19 changes: 10 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
Small typos or grammatical errors in documentation may be edited directly using
the GitHub web interface, so long as the changes are made in the _source_ file.

* YES: you edit a roxygen comment in a `.R` file below `R/`.
* NO: you edit an `.Rd` file below `man/`.
* DO: edit a roxygen comment in a `.R` file below `R/`.
* DON'T: edit an `.Rd` file below `man/`.

### Prerequisites

Expand All @@ -18,12 +18,13 @@ bug, create an associated issue and illustrate the bug with a minimal
### Pull request process

* We recommend that you create a Git branch for each pull request (PR).
* Look at the Travis and CodeCovr build status before and after making changes.
* Look at the GitHub actions and CodeCovr build status before and after making changes.
* We follow [Google's R style guide](https://google.github.io/styleguide/Rguide.html)
* We use camelCase for variable names, and TitleCase for function names.
* We use the Oxford ending of 'ize' (not 'ise'), and UK spelling (e.g. 'colour')
where it is not possible to avoid the distinction (e.g. by shortening to 'col')
* We use [roxygen2](https://cran.r-project.org/package=roxygen2).
* We use [roxygen2](https://cran.r-project.org/package=roxygen2) to build
documentation.
* We use [testthat](https://cran.r-project.org/package=testthat). Contributions
with test cases included are easier to accept.
* For user-facing changes, add a bullet to the top of `NEWS.md` below the
Expand All @@ -36,12 +37,12 @@ Please note that the project is released with a
[Contributor Code of Conduct](CODE_OF_CONDUCT.md). By contributing to this
project you agree to abide by its terms.

### Prefer to Email?
### Prefer to e-mail?

Email the person listed as maintainer in the `DESCRIPTION` file of this repo.

Though note that private discussions over email don't help others - of course email is totally warranted if it's a sensitive problem of any kind.
E-mail the person listed as maintainer in the `DESCRIPTION` file of this repo.
Private discussions over email don't help others - but of course email is
totally warranted for any sensitive problems.

### Thanks for contributing!

This contributing guide is adapted from the tidyverse contributing guide available at https://raw.githubusercontent.com/r-lib/usethis/master/inst/templates/tidy-contributing.md
This document is adapted from the [tidyverse contributing guide](https://raw.githubusercontent.com/r-lib/usethis/master/inst/templates/tidy-contributing.md).

0 comments on commit 3b5181d

Please sign in to comment.