-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
added .github dir with contribuint, issue and PR templates
- Loading branch information
Showing
4 changed files
with
102 additions
and
0 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 |
---|---|---|
|
@@ -15,3 +15,5 @@ cran-comments.md | |
^CONDUCT\.md$ | ||
^cran-comments\.md$ | ||
revdep | ||
.github | ||
|
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,76 @@ | ||
# CONTRIBUTING # | ||
|
||
## Please contribute! | ||
|
||
We love collaboration. | ||
|
||
## Bugs? | ||
|
||
* Submit an issue on the [Issues page](https://github.com/ropensci/rcrossref/issues) - be sure to include R session information and a reproducible example. | ||
|
||
## Code contributions | ||
|
||
### Broad overview of contributing workflow | ||
|
||
* Fork this repo to your Github account | ||
* Clone your version on your account down to your machine from your account, e.g,. `git clone https://github.com/<yourgithubusername>/rcrossref.git` | ||
* Make sure to track progress upstream (i.e., on our version of `rcrossref` at `ropensci/rcrossref`) by doing `git remote add upstream https://github.com/ropensci/rcrossref.git`. Before making changes make sure to pull changes in from upstream by doing either `git fetch upstream` then merge later or `git pull upstream` to fetch and merge in one step | ||
* Make your changes (bonus points for making changes on a new feature branch) | ||
* Please do write a test(s) for your changes if they affect code and not just docs (see Tests below) | ||
* Push up to your account | ||
* Submit a pull request to home base at `ropensci/rcrossref` | ||
|
||
### Tests | ||
|
||
To add tests, go to the folder `tests/testthat/`. Tests are generally organized as individual files for each exported function from the package (that is, listed as an export in the `NAMESPACE` file). If you are adding a new exported function, add a new test file. If you are changing an existing function, work in the tests file for that function, unless it doesn't have tests, in which case make a new test file. | ||
|
||
The book R packages book provides [a chapter on testing in general](http://r-pkgs.had.co.nz/tests.html). Do consult that first if you aren't familiar with testing in R. | ||
|
||
The easiest set up to run tests is from within an R session: | ||
|
||
```r | ||
library(devtools) | ||
library(testthat) | ||
# loads the package | ||
load_all() | ||
``` | ||
|
||
To test an individual test file | ||
|
||
```r | ||
test_file("tests/testthat/test-foobar.R") | ||
``` | ||
|
||
To run all tests | ||
|
||
```r | ||
devtools::test() | ||
``` | ||
|
||
If you are running tests that have `skip_on_cran()` in them, set `Sys.setenv(NOT_CRAN = "true")` prior to running tests. | ||
|
||
|
||
### Making changes | ||
|
||
In addition to changing the code, do make sure to udpate the documentation if applicable. The R packages book book has a [chapter on documentation](http://r-pkgs.had.co.nz/man.html) you should read if you aren't familiar. | ||
|
||
After code and documentation has been changed, update documentation by running either `devtools::document()` or `roxygen2::roxygenise()`. | ||
|
||
Make sure if you change what packages or even functions within packages are imported, most likely add the package to Imports in the DESCRIPTION file and list what functions are imported in the `rcrossref-package.R` file. | ||
|
||
Be conservative about adding new dependencies. | ||
|
||
|
||
### Style | ||
|
||
* Make sure code, documentation, and comments are no more than 80 characters in width. | ||
* Use `<-` instead of `=` for assignment | ||
* Always use `snake_case` (and all lowercase) instead of `camelCase` | ||
|
||
|
||
|
||
## Also, check out our [discussion forum](https://discuss.ropensci.org) | ||
|
||
## Prefer to Email? Get in touch: [scott@ropensci.org](mailto:scott@ropensci.org) | ||
|
||
## Thanks for contributing! |
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,8 @@ | ||
<!-- If this issue relates to usage of the package, whether a question, bug or similar, along with your query, please paste your devtools::session_info() or sessionInfo() into the code block below. If not, delete all this and proceed :) --> | ||
|
||
<details> <summary><strong>Session Info</strong></summary> | ||
|
||
```r | ||
|
||
``` | ||
</details> |
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,16 @@ | ||
<!--- 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 --> |