-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
via rOpenSci templates
- Loading branch information
Showing
3 changed files
with
76 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
# CONTRIBUTING # | ||
|
||
### Fixing typos | ||
|
||
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/`. | ||
|
||
### Prerequisites | ||
|
||
Before you make a substantial pull request, you should always file an issue and | ||
make sure someone from the team agrees that it鈥檚 a problem. If you鈥檝e found a | ||
bug, create an associated issue and illustrate the bug with a minimal | ||
[reprex](https://www.tidyverse.org/help/#reprex). | ||
|
||
### Pull request process | ||
|
||
* We recommend that you create a Git branch for each pull request (PR). | ||
* Look at the GitHub Actions build status before and after making changes. | ||
The `README` should contain badges for any continuous integration services used | ||
by the package. | ||
* We recommend the tidyverse [style guide](http://style.tidyverse.org). | ||
You can use the [styler](https://CRAN.R-project.org/package=styler) package to | ||
apply these styles, but please don't restyle code that has nothing to do with | ||
your PR. | ||
* We use [roxygen2](https://cran.r-project.org/package=roxygen2). | ||
* 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 | ||
current development version header describing the changes made followed by your | ||
GitHub username, and links to relevant issue(s)/PR(s). | ||
|
||
### See rOpenSci [contributing guide](https://devguide.ropensci.org/contributingguide.html) | ||
for further details. | ||
|
||
### Discussion forum | ||
|
||
Check out our [discussion forum](https://discuss.ropensci.org) if | ||
|
||
* you have a question, an use case, or otherwise not a bug or feature request for the software itself. | ||
* you think your issue requires a longer form discussion. | ||
|
||
### Prefer to Email? | ||
|
||
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. | ||
|
||
### 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 file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
<!-- IF THIS INVOLVES AUTHENTICATION: DO NOT SHARE YOUR USERNAME/PASSWORD, OR API KEYS/TOKENS IN THIS ISSUE - MOST LIKELY THE MAINTAINER WILL HAVE THEIR OWN EQUIVALENT KEY --> | ||
|
||
<!-- If you've updated a file in the man-roxygen directory, make sure to update the man/ files by running devtools::document() or similar as .Rd files should be affected by your change --> | ||
|
||
<!--- Provide a general summary of your changes in the Title above --> | ||
|
||
## Description | ||
<!--- Describe your changes in detail --> | ||
|
||
## Related Issue | ||
<!--- if this closes an issue make sure include e.g., "fix #4" | ||
or similar - or if just relates to an issue make sure to mention | ||
it like "#4" --> | ||
|
||
## Example | ||
<!--- if introducing a new feature or changing behavior of existing | ||
methods/functions, include an example if possible to do in brief form --> | ||
|
||
<!--- Did you remember to include tests? Unless you're just changing | ||
grammar, please include new tests for your change --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters