Skip to content

Commit bc711d2

Browse files
committed
update CONTRIBUTING.md
1 parent 72f6549 commit bc711d2

File tree

1 file changed

+23
-22
lines changed

1 file changed

+23
-22
lines changed

.github/CONTRIBUTING.md

Lines changed: 23 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,57 @@
1-
# CONTRIBUTING #
1+
# CONTRIBUTING
22

33
### Fixing typos
44

55
Small typos or grammatical errors in documentation may be edited directly using
66
the GitHub web interface, so long as the changes are made in the _source_ file.
77

8-
* YES: you edit a roxygen comment in a `.R` file below `R/`.
9-
* NO: you edit an `.Rd` file below `man/`.
8+
- YES: you edit a roxygen comment in a `.R` file below `R/`.
9+
- NO: you edit an `.Rd` file below `man/`.
1010

1111
### Prerequisites
1212

1313
Before you make a substantial pull request, you should always file an issue and
1414
make sure someone from the team agrees that it’s a problem. If you’ve found a
15-
bug, create an associated issue and illustrate the bug with a minimal
15+
bug, create an associated issue and illustrate the bug with a minimal
1616
[reprex](https://www.tidyverse.org/help/#reprex).
1717

1818
### Pull request process
1919

20-
* We recommend that you create a Git branch for each pull request (PR).
21-
* Look at the Travis and AppVeyor build status before and after making changes.
22-
The `README` should contain badges for any continuous integration services used
23-
by the package.
24-
* We recommend the tidyverse [style guide](http://style.tidyverse.org).
25-
You can use the [styler](https://CRAN.R-project.org/package=styler) package to
26-
apply these styles, but please don't restyle code that has nothing to do with
27-
your PR.
28-
* We use [roxygen2](https://cran.r-project.org/package=roxygen2).
29-
* We use [testthat](https://cran.r-project.org/package=testthat). Contributions
30-
with test cases included are easier to accept.
31-
* For user-facing changes, add a bullet to the top of `NEWS.md` below the
32-
current development version header describing the changes made followed by your
33-
GitHub username, and links to relevant issue(s)/PR(s).
20+
- We recommend that you create a Git branch for each pull request (PR).
21+
- Look at the Travis and AppVeyor build status before and after making changes.
22+
The `README` should contain badges for any continuous integration services used
23+
by the package.
24+
- We recommend the tidyverse [style guide](http://style.tidyverse.org).
25+
You can use the [styler](https://CRAN.R-project.org/package=styler) package or
26+
the [Air formatter](https://posit-dev.github.io/air/formatter.html) to apply
27+
these styles, but please don't restyle code that has nothing to do with your PR.
28+
- We use [roxygen2](https://cran.r-project.org/package=roxygen2).
29+
- We use [testthat](https://cran.r-project.org/package=testthat). Contributions
30+
with test cases included are easier to accept.
31+
- For user-facing changes, add a bullet to the top of `NEWS.md` below the
32+
current development version header describing the changes made followed by your
33+
GitHub username, and links to relevant issue(s)/PR(s).
3434

3535
### Code of Conduct
3636

37-
Please note that the getCRUCLdata project is released with a
37+
Please note that the nasapower project is released with a
3838
[Contributor Code of Conduct](CODE_OF_CONDUCT.md). By contributing to this
3939
project you agree to abide by its terms.
4040

4141
### See rOpenSci [contributing guide](https://ropensci.github.io/dev_guide/contributingguide.html)
42+
4243
for further details.
4344

4445
### Discussion forum
4546

4647
Check out our [discussion forum](https://discuss.ropensci.org) if you think your issue requires a longer form discussion.
4748

48-
### Prefer to Email?
49+
### Prefer to Email?
4950

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

5253
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.
5354

54-
### Thanks for contributing!
55+
### Thanks for contributing
5556

56-
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
57+
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>

0 commit comments

Comments
 (0)