Merge pull request #25 from jhayer/documentation-community-guidelines

add contributing guidelines to README.md (fix #24 and #28)
jhayer · Jul 13, 2023 · 7af7b0d · 7af7b0d
2 parents c00209d + cb08207
commit 7af7b0d
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -525,8 +525,21 @@ conda environment:
 conda remove -n baargin
 ```
 
+
+## Contributing
+
+We welcome contributions from the community! See our [Contributing guidelines](https://github.com/jhayer/baargin/blob/main/CONTRIBUTING.md)
+
+## Report bugs and issues
+
+Found a bug or have a question? Please open an [issue](https://github.com/jhayer/baargin/issues).
+Precisions on how to report issues are given in our [Contributing guidelines](https://github.com/jhayer/baargin/blob/main/CONTRIBUTING.md)
+
+
 ## Citation
 
+Coming soon...
+
 ## Author and contributors
 
 Juliette Hayer  (@jhayer)