Merge pull request #142 from GoekeLab/contributing

Create CONTRIBUTING.md

Author: yuukiiwa

CONTRIBUTING.md

@@ -0,0 +1,37 @@
+## How to contribute to m6Anet
+
+#### **Did you find a bug?**
+
+* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/GoekeLab/m6anet/issues).
+
+* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/GoekeLab/m6anet/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.
+
+#### **Did you write a patch that fixes a bug?**
+
+* Open a new GitHub pull request with the patch.
+
+* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
+
+* Before submitting, please read the [PEP 8 – Style Guide for Python Code](https://peps.python.org/pep-0008/) to know more about coding conventions used in m6Anet.
+
+#### **Do you intend to add a new feature or change an existing one?**
+
+* Suggest your change in the [Discussions (ideas)](https://github.com/GoekeLab/m6anet/discussions/categories/ideas)
+
+* Do not open an issue on GitHub until you have collected positive feedback about the change. GitHub issues are primarily intended for bug reports and fixes.
+
+#### **Do you have questions about the source code, publication, or use cases of m6Anet?**
+
+* Ask any question about how to use m6Anet, where to find data sets, or possible extensions in the [Discussions (Q&A)](https://github.com/GoekeLab/m6anet/discussions/categories/q-a).
+
+#### **Have you used m6Anet and was it helpful for your research?**
+
+* Let us and the community know how you used m6Anet! You can post a summary with links to a preprint or manuscript in the [Discussions (show and tell)](https://github.com/GoekeLab/m6anet/discussions/categories/show-and-tell)
+
+Thanks! :heart: :heart: :heart:
+
+the m6Anet team
+
+## Attribution
+
+These community contribution guidelines are adapted from Ruby on Rails contribution guidelines available at https://github.com/rails/rails/blob/main/CONTRIBUTING.md

README.md

@@ -284,8 +284,11 @@ In order to run the Arabidopsis model, please add the following command when run
 # Getting help
 We appreciate your feedback and questions! You can report any error or suggestion related to m6Anet as an issue on [github](https://github.com/GoekeLab/m6anet/issues). If you have questions related to the manuscript, data, or any general comment or suggestion please use the [Discussions](https://github.com/GoekeLab/m6anet/discussions).
 
-Thank you!
+### Contribution
+
+We appreciate contributions on bug fixes and potential new features. Please read our [Contribution Guidelines](https://github.com/GoekeLab/m6anet/blob/master/CONTRIBUTING.md) for more information.
 
+Thank you!
 
 # Citing m6Anet