Skip to content

Commit 3b0698e

Browse files
committed
added contributing file
1 parent 7125f85 commit 3b0698e

File tree

1 file changed

+27
-20
lines changed

1 file changed

+27
-20
lines changed

.github/CONTRIBUTING.md

+27-20
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,54 @@
1+
---
2+
editor_options:
3+
markdown:
4+
wrap: sentence
5+
---
6+
17
# Contributing to dendroNetwork
28

39
This outlines how to propose a change to dendroNetwork.
4-
For a detailed discussion on contributing to this and other tidyverse packages, please see the [development contributing guide](https://rstd.io/tidy-contrib) and our [code review principles](https://code-review.tidyverse.org/).
510

611
## Fixing typos
712

8-
You can fix typos, spelling mistakes, or grammatical errors in the documentation directly using the GitHub web interface, as long as the changes are made in the _source_ file.
9-
This generally means you'll need to edit [roxygen2 comments](https://roxygen2.r-lib.org/articles/roxygen2.html) in an `.R`, not a `.Rd` file.
13+
You can fix typos, spelling mistakes, or grammatical errors in the documentation directly using the GitHub web interface, as long as the changes are made in the *source* file.
14+
This generally means you'll need to edit [roxygen2 comments](https://roxygen2.r-lib.org/articles/roxygen2.html) in an `.R`, not a `.Rd` file.
1015
You can find the `.R` file that generates the `.Rd` by reading the comment in the first line.
1116

1217
## Bigger changes
1318

14-
If you want to make a bigger change, it's a good idea to first file an issue and make sure someone from the team agrees that it’s needed.
15-
If you’ve found a bug, please file an issue that illustrates the bug with a minimal
16-
[reprex](https://www.tidyverse.org/help/#reprex) (this will also help you write a unit test, if needed).
19+
If you want to make a bigger change, it's a good idea to first file an issue and make sure someone from the team agrees that it's needed.
20+
If you've found a bug, please file an issue that illustrates the bug with a minimal [reprex](https://www.tidyverse.org/help/#reprex) (this will also help you write a unit test, if needed).
1721
See our guide on [how to create a great issue](https://code-review.tidyverse.org/issues/) for more advice.
1822

1923
### Pull request process
2024

21-
* Fork the package and clone onto your computer. If you haven't done this before, we recommend using `usethis::create_from_github("RonaldVisser/dendroNetwork", fork = TRUE)`.
25+
- Fork the package and clone onto your computer.
26+
If you haven't done this before, we recommend using `usethis::create_from_github("RonaldVisser/dendroNetwork", fork = TRUE)`.
27+
28+
- Install all development dependencies with `devtools::install_dev_deps()`, and then make sure the package passes R CMD check by running `devtools::check()`.
29+
If R CMD check doesn't pass cleanly, it's a good idea to ask for help before continuing.
2230

23-
* Install all development dependencies with `devtools::install_dev_deps()`, and then make sure the package passes R CMD check by running `devtools::check()`.
24-
If R CMD check doesn't pass cleanly, it's a good idea to ask for help before continuing.
25-
* Create a Git branch for your pull request (PR). We recommend using `usethis::pr_init("brief-description-of-change")`.
31+
- Create a Git branch for your pull request (PR).
32+
We recommend using `usethis::pr_init("brief-description-of-change")`.
2633

27-
* Make your changes, commit to git, and then create a PR by running `usethis::pr_push()`, and following the prompts in your browser.
34+
- Make your changes, commit to git, and then create a PR by running `usethis::pr_push()`, and following the prompts in your browser.
2835
The title of your PR should briefly describe the change.
2936
The body of your PR should contain `Fixes #issue-number`.
3037

31-
* For user-facing changes, add a bullet to the top of `NEWS.md` (i.e. just below the first header). Follow the style described in <https://style.tidyverse.org/news.html>.
38+
- For user-facing changes, add a bullet to the top of `NEWS.md` (i.e. just below the first header).
39+
Follow the style described in <https://style.tidyverse.org/news.html>.
3240

3341
### Code style
3442

35-
* New code should follow the tidyverse [style guide](https://style.tidyverse.org).
36-
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.
43+
- New code should follow the tidyverse [style guide](https://style.tidyverse.org).
44+
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.
3745

38-
* We use [roxygen2](https://cran.r-project.org/package=roxygen2), with [Markdown syntax](https://cran.r-project.org/web/packages/roxygen2/vignettes/rd-formatting.html), for documentation.
46+
- We use [roxygen2](https://cran.r-project.org/package=roxygen2), with [Markdown syntax](https://cran.r-project.org/web/packages/roxygen2/vignettes/rd-formatting.html), for documentation.
3947

40-
* We use [testthat](https://cran.r-project.org/package=testthat) for unit tests.
41-
Contributions with test cases included are easier to accept.
48+
- We use [testthat](https://cran.r-project.org/package=testthat) for unit tests.
49+
Contributions with test cases included are easier to accept.
4250

4351
## Code of Conduct
4452

45-
Please note that the dendroNetwork project is released with a
46-
[Contributor Code of Conduct](CODE_OF_CONDUCT.md). By contributing to this
47-
project you agree to abide by its terms.
53+
Please note that the dendroNetwork project is released with a [Code of Conduct](https://ropensci.org/code-of-conduct/).
54+
By contributing to this project you agree to abide by its terms.

0 commit comments

Comments
 (0)