Add contribution to readme

willgryan · Oct 6, 2023 · e63a2a3 · e63a2a3
1 parent 511039d
commit e63a2a3
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 2 deletions.
diff --git a/.Rbuildignore b/.Rbuildignore
@@ -3,6 +3,7 @@
 ^PAVER\.Rproj$
 ^\.Rproj\.user$
 ^LICENSE\.md$
+^CODE_OF_CONDUCT\.md$
 ^README\.Rmd$
 ^\.github$
 paper.md

diff --git a/README.Rmd b/README.Rmd
@@ -32,5 +32,9 @@ remotes::install_github("willgryan/PAVER")
 
 ## Usage
 
-PAVER is designed to work with the output of pathway analysis tools. The package includes a vignette with an example dataset.
+PAVER is designed to work with the output of pathway analysis tools. The package includes a vignette with an example datase that explains it's functionality.
+
+## Contributing
+
+We welcome anyone wishing to contribute, report issues or seek support for PAVER. Please note, PAVER is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By contributing to this project, you agree to abide by its terms.
 
diff --git a/README.md b/README.md
@@ -23,4 +23,12 @@ remotes::install_github("willgryan/PAVER")
 ## Usage
 
 PAVER is designed to work with the output of pathway analysis tools. The
-package includes a vignette with an example dataset.
+package includes a vignette with an example datase that explains it’s
+functionality.
+
+## Contributing
+
+We welcome anyone wishing to contribute, report issues or seek support
+for PAVER. Please note, PAVER is released with a [Contributor Code of
+Conduct](CODE_OF_CONDUCT.md). By contributing to this project, you agree
+to abide by its terms.