Merge pull request #9 from ioxiocom/chore/contributing

Adding contribution guidelines

Author: lietu

.github/CONTRIBUTING.md

@@ -0,0 +1,43 @@
+# Contributing to this project
+
+Thank you for your interest in contributing! We welcome contributions of all kinds, from
+bug reports to new features. This document outlines our guidelines to make the process
+smooth and effective.
+
+## Code of Conduct
+
+We are committed to providing a welcoming and respectful community for everyone. We
+expect all contributors to adhere to a high standard of conduct. **Harassment, abusive
+language, discrimination (including but not limited to racism, sexism, homophobia,
+transphobia, ableism, or any other form of prejudice) will not be tolerated.**
+Violations may result in removal from the project and/or reporting.
+
+## How to contribute
+
+1. **Discuss first:** Before tackling a significant change or feature, please open an
+   issue to discuss your idea. This helps ensure it aligns with the project's goals and
+   avoids wasted effort.
+
+2. **Code style & formatting:** We aim for consistent code style throughout the project.
+
+   - Please run any automated formatting tools included in this repository (e.g.,
+     `pre-commit`, `prettier`, `ruff`, `go fmt`). Check the `.editorconfig` or build
+     scripts for details.
+   - Try to follow existing coding conventions within the codebase.
+
+3. **Submit a pull request:** When you're ready to contribute:
+
+   - Create a pull request against the `main` branch.
+   - In your PR description, _clearly explain_:
+     - **What changed?** A concise summary of your changes.
+     - **Why did you make this change?** What problem does it solve or what improvement
+       does it offer?
+     - **Output Changes (if applicable):** If your changes affect the output of the
+       project (e.g., UI, logs), please include screenshots _before and after_ to
+       illustrate the impact.
+
+4. **Be patient:** We are a small team with limited time dedicated to managing this
+   repository. We will review pull requests as quickly as possible, but it may take some
+   time. Your patience is greatly appreciated!
+
+Thanks again for your contribution!