Skip to content

Commit 4f4604c

Browse files
authored
Update CONTRIBUTING.md
1 parent 9d05319 commit 4f4604c

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

.github/CONTRIBUTING.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,15 +25,22 @@ You may also wish to contact the development team for bigger changes. Please see
2525
* Install all development dependencies with `devtools::install_dev_deps()`, and then make sure the package passes R CMD check by running `devtools::check()`.
2626
If R CMD check doesn't pass cleanly, it's a good idea to ask for help before continuing.
2727

28-
* Create a Git branch for your pull request (PR). We recommend using `usethis::pr_init("brief-description-of-change")`. This is important: even for team members, please make commits to branches, first.
28+
* Create a Git branch for your pull request (PR). We recommend using `usethis::pr_init("brief-description-of-change")`. This is important: **even for team members, please make commits to branches, first**.
2929

30-
* Ensure that all checks are passing. You can see this information within your PR. If a check is not passing, correct the issue or contact a package maintainer for help.
30+
* Ensure that all checks are passing. You can see this information within your PR (on GitHub). It will say passing or failing, and if failing, you can see what is the cause. If a check is not passing, correct the issue or contact a package maintainer for help.
3131

32-
* Please run `goodpractice::gp()` to ensure code quality compliance. Some markers from this can justifiably be ignored, whereas others must be addressed. See a discussion [here](https://github.com/konfound-project/konfound/issues/50)
32+
* Please run `goodpractice::gp()` to ensure code quality compliance. Some markers from this can justifiably be ignored, whereas others must be addressed. See a discussion [here](https://github.com/konfound-project/konfound/issues/50). Some things to be aware of:
33+
* avoiding long code lines (more than 80 characters)
34+
* using TRUE and FALSE instead of T and F
35+
* using roxygen2 syntax to import specific functions from packages
36+
* avoiding functions that are overly complex (i.e., avoiding high cyclomatic complexity)
37+
38+
* For new functions or functionality, write examples and tests to cover the core of the functionality. Aim for 80% or higher test coverage for new functions. Check with `covr::package_coverage()`.
3339

3440
* Make your changes, commit to git, and then create a PR by running `usethis::pr_push()`, and following the prompts in your browser.
3541
The title of your PR should briefly describe the change.
3642
The body of your PR should contain `Fixes #issue-number`.
43+
3744
* A member of the team will then review your PR.
3845

3946
* 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>.

0 commit comments

Comments
 (0)