From 57fec8489b4e159dc13941b42b86be5f88f882af Mon Sep 17 00:00:00 2001
From: Jonathan <42983653+jonnyz32@users.noreply.github.com>
Date: Fri, 20 Sep 2024 11:46:12 -0400
Subject: [PATCH] Add contributing.md (#151)

Co-authored-by: Sanjula Ganepola <32170854+SanjulaGanepola@users.noreply.github.com>
---
 docs/_sidebar.md     |  3 ++-
 docs/contributing.md | 50 ++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 52 insertions(+), 1 deletion(-)
 create mode 100644 docs/contributing.md

diff --git a/docs/_sidebar.md b/docs/_sidebar.md
index 3a451fd..d009f93 100644
--- a/docs/_sidebar.md
+++ b/docs/_sidebar.md
@@ -9,4 +9,5 @@
    * Examples
       * [File](config/examples/file.md)
       * [Twilio](config/examples/twilio.md)
-      * [Sentry watch](config/examples/sentry.md)
\ No newline at end of file
+      * [Sentry watch](config/examples/sentry.md)
+* [Contributing](contributing.md)
\ No newline at end of file
diff --git a/docs/contributing.md b/docs/contributing.md
new file mode 100644
index 0000000..c42572a
--- /dev/null
+++ b/docs/contributing.md
@@ -0,0 +1,50 @@
+# Contributing to Manzan
+
+Thank you for considering contributing to **Manzan**! We welcome all contributions, from bug reports and documentation improvements to feature requests and code submissions.
+
+## How to Contribute
+
+### 1. Reporting Bugs
+
+If you find a bug in the project, please open an issue in the [GitHub Issues](https://github.com/ThePrez/Manzan/issues) section. Make sure to include:
+
+- A clear and descriptive title.
+- Steps to reproduce the issue.
+- The expected and actual behavior.
+- Any relevant logs, screenshots, or error messages.
+
+### 2. Suggesting Features or Enhancements
+
+We love new ideas! If you have a feature request or enhancement suggestion, please open an issue labeled as `enhancement`. Describe the following:
+
+- The problem or limitation the feature would solve.
+- A detailed description of the proposed solution.
+- Alternatives you’ve considered, if applicable.
+
+### 3. Code Contributions
+
+We welcome pull requests (PRs) from everyone. To contribute code:
+
+1. **Fork the repository** and clone your fork to your machine.
+2. **Create a new branch** for your feature or bug fix:
+   ```bash
+   git checkout -b my-feature
+   ```
+3. **Make your changes** and commit them with clear, descriptive messages:
+    ```bash
+    git commit -s -m "Add feature XYZ"
+    ```
+4. **Follow the existing code style** used in the project and ensure all new code is tested, documented, and free of linting issues.
+5. **Push to your fork:**
+    ```bash
+    git push origin my-feature
+    ```
+6. **Submit a Pull Request** (PR) to the main branch of the main repository.
+
+For more instructions on how to setup your development environment, build the Mazan components (handler/distributor), and run tests, check out the detailed guide [here](https://github.com/ThePrez/Manzan/blob/main/CONTRIBUTING.md).
+
+### 4. Documentation Improvements
+If you find gaps or errors in the documentation, feel free to submit a pull request with your corrections. Documentation contributions are always welcome!
+
+## Review Process
+After you submit a PR, it will be reviewed by the project maintainers. Maintain open communication with the reviewer(s) and address any feedback. Once approved, your PR will be merged into the main branch.