Merge branch 'master' of https://github.com/konfound-project/konfound

.github/CONTRIBUTING.md

@@ -25,15 +25,22 @@ You may also wish to contact the development team for bigger changes. Please see
 *   Install all development dependencies with `devtools::install_dev_deps()`, and then make sure the package passes R CMD check by running `devtools::check()`. 
     If R CMD check doesn't pass cleanly, it's a good idea to ask for help before continuing.
 
-*   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.
+*   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**.
 
-*   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.
+*   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.
 
-*   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)
+*   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:
+    * avoiding long code lines (more than 80 characters)
+    * using TRUE and FALSE instead of T and F
+    * using roxygen2 syntax to import specific functions from packages
+    * avoiding functions that are overly complex (i.e., avoiding high cyclomatic complexity)
+
+*   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()`. 
 
 *   Make your changes, commit to git, and then create a PR by running `usethis::pr_push()`, and following the prompts in your browser.
     The title of your PR should briefly describe the change.
     The body of your PR should contain `Fixes #issue-number`.
+
 *   A member of the team will then review your PR.
 
 *  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>.