From 72bb6d4d0b62dee00e3c6fa42a6c0063dd1e624e Mon Sep 17 00:00:00 2001
From: Vijini Mallawaarachchi <viji.mallawaarachchi@gmail.com>
Date: Fri, 8 Mar 2024 09:46:50 +1030
Subject: [PATCH] DOC: Create CONTRIBUTING.md

---
 CONTRIBUTING.md | 101 ++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 101 insertions(+)
 create mode 100644 CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..b273f65
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,101 @@
+# Contributing to ConDiGA project
+
+We love to have your contributions to the ConDiGA project, whether it's:
+* Reporting a bug
+* Submitting a fix
+* Proposing new features
+
+## Clone and install ConDiGA onto your machine
+
+First, make sure you have [git](https://github.com/git-guides/install-git) installed on your machine.
+
+On GitHub, [fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) the ConDiGA repository and [clone](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) it to your machine.
+
+```bash
+# clone repository to your local machine
+git clone https://github.com/metagentools/ConDiGA.git
+```
+
+Move to the ConDiGA directory 
+
+```bash
+cd ConDiGA
+```
+
+Create and activate the conda environment. Make sure to have [`conda`](https://docs.conda.io/en/latest/) installed.
+
+```bash
+# Create the condiga environment
+conda env create -f build/environment.yml
+
+# Activate the condiga environment
+conda activate condiga
+```
+
+Now install ConDiGA via [`pip`](https://pip.pypa.io/en/stable/).
+
+```bash
+pip install -e .
+```
+
+## Test ConDiGA installation
+
+Print the help message using the following command.
+
+```bash
+condiga -h
+```
+
+## Coding Style
+
+We adhere to the [PEP 8](https://peps.python.org/pep-0008/) style guide. 
+
+Before committing, make sure to run [`black`](https://pypi.org/project/black/) and [`isort`](https://pypi.org/project/isort/).
+
+```bash
+black ./
+isort --atomic ./
+```
+
+## Report bugs using GitHub's issues
+
+We use GitHub issues to track public bugs. Report a bug by opening a new issue in GitHub [issues](https://github.com/metagentools/ConDiGA/issues). You will get to select between templates for bug report and feature request. If none of these templates match what you want to report, you can use the custom issue template.
+
+## Committing code
+
+Once you have finished coding and all the tests pass, commit your code and make a pull request. 
+
+```bash
+# Add changed/added files
+git add <file name>
+
+# Commit changes
+git commit -m "<commit message>"
+
+# Push changes
+git push
+```
+
+Make sure to follow the commit style of [c3dev](https://github.com/cogent3/c3dev/wiki#style-for-commit-messages). Relevant prefixes are replicated below for convenience.
+
+| **Commit Prefix** | **For**                                       |
+|-------------------|-----------------------------------------------|
+| DEV:              | development tool or utility                   |
+| DOC:              | documentation                                 |
+| TST:              | addition or modification of tests             |
+| REL:              | related to a release                          |
+| MAINT:            | maintenance commit (refactoring, typos, etc.) |
+| BUG:              | bug fix                                       |
+| GIT:              | git related                                   |
+| REV:              | revert an earlier commit                      |
+
+
+Your contribution will be reviewed before accepting it. 
+
+## License
+
+By contributing, you agree that your contributions will be licensed under the MIT License.
+
+## References
+
+This document was adapted from the open-source contribution guidelines for [Transcriptase](https://github.com/briandk/transcriptase-atom/blob/master/CONTRIBUTING.md) and [c3dev](https://github.com/cogent3/c3dev/wiki/How-to-Contribute-Code).