docs: add CONTRIBUTING.md

This commit is contained in:
Anton Petnitsky 2026-07-09 05:31:03 +03:00
commit fa27d263e5

54
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,54 @@
# Contributing
Thank you for your interest in contributing! We appreciate all contributions,
from bug reports to feature requests and code improvements.
## How to Contribute
### Reporting Bugs
- Check existing [issues](../../issues) first to avoid duplicates
- Open a new issue with a clear title and description
- Include steps to reproduce, expected vs actual behavior, and environment details
### Suggesting Features
- Open an issue with the `enhancement` label
- Describe the feature and explain why it would be valuable
### Submitting Code
1. **Fork** this repository
2. **Create a branch** from `main`:
```bash
git checkout -b feature/your-feature-name
```
3. **Make your changes** and add tests if applicable
4. **Commit** with a clear message:
```bash
git commit -m "feat: add your feature description"
```
5. **Push** to your fork and open a **Pull Request**
## Guidelines
- Follow the existing code style and conventions
- Keep PRs focused on a single concern
- Write clear commit messages
- Update documentation when changing behavior
- Be respectful and constructive in all interactions (see [Code of Conduct](CODE_OF_CONDUCT.md))
## Development Setup
```bash
# Clone your fork
git clone https://github.com/YOUR_USERNAME/REPO_NAME.git
cd REPO_NAME
# Install dependencies (see README for details)
```
## Questions?
Open an issue or start a discussion — we're happy to help!
---
*Documentation contributed by [Mukller](https://github.com/Mukller)*