Create CONTRIBUTING.md
This commit is contained in:
46
CONTRIBUTING.md
Normal file
46
CONTRIBUTING.md
Normal file
@@ -0,0 +1,46 @@
|
|||||||
|
# Contributing Guidelines
|
||||||
|
|
||||||
|
Thank you for considering contributing to this project! We welcome contributions from the community and are grateful for your support.
|
||||||
|
|
||||||
|
## 📋 How to Contribute
|
||||||
|
|
||||||
|
1. **Fork the repository**
|
||||||
|
|
||||||
|
- Click the "Fork" button at the top of the repository page.
|
||||||
|
|
||||||
|
2. **Create a branch**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git checkout -b feature/your-feature-name
|
||||||
|
```
|
||||||
|
|
||||||
|
3. **Make your changes**
|
||||||
|
|
||||||
|
- Follow the existing code style.
|
||||||
|
- Write clear commit messages.
|
||||||
|
|
||||||
|
4. **Test your changes**
|
||||||
|
|
||||||
|
- Ensure all tests pass and new code is covered.
|
||||||
|
|
||||||
|
5. **Submit a pull request (PR)**
|
||||||
|
|
||||||
|
- Push your branch to your fork.
|
||||||
|
- Open a PR against the `main` branch.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🛠 Development Guidelines
|
||||||
|
|
||||||
|
- Use `.editorconfig` for consistent formatting.
|
||||||
|
- Keep commits focused — one feature/fix per commit.
|
||||||
|
- Write documentation for new features.
|
||||||
|
|
||||||
|
## 📜 Code of Conduct
|
||||||
|
|
||||||
|
By participating in this project, you agree to follow our [Code of Conduct](CODE_OF_CONDUCT.md).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
© 2025 Moko Consulting. Licensed under the GNU General Public License v3.0 or later (GPL-3.0-or-later).
|
||||||
|
|
||||||
Reference in New Issue
Block a user