zwf
41 lines
1.4 KiB
Markdown
41 lines
1.4 KiB
Markdown
# Contribution Guidelines
|
||
|
||
Thank you for considering contributing to this project! Your involvement helps make this project better for everyone.
|
||
|
||
## How to Contribute
|
||
|
||
1. **Fork the repository**
|
||
2. **Create a new feature branch**
|
||
```bash
|
||
git checkout -b feature/your-feature-name
|
||
```
|
||
3. **Make your changes**
|
||
Write clean, well-documented code. Follow the project’s coding standards.
|
||
4. **Add tests**
|
||
All new features or bug fixes must include appropriate unit or integration tests.
|
||
5. **Commit your changes**
|
||
Use descriptive commit messages following [Conventional Commits](https://www.conventionalcommits.org/).
|
||
6. **Push to your fork**
|
||
```bash
|
||
git push origin feature/your-feature-name
|
||
```
|
||
7. **Open a Pull Request**
|
||
Clearly describe what you changed, why, and how it affects the project.
|
||
|
||
## Code Style & Standards
|
||
|
||
- Follow the project’s linter rules (e.g., PEP8 for Python, ESLint for JavaScript)
|
||
- Keep functions small and focused
|
||
- Document public APIs with docstrings or comments
|
||
- Never commit secrets or environment files
|
||
|
||
## Reporting Issues
|
||
|
||
If you find a bug or have a feature request, please open an [Issue](https://github.com/your-repo/issues) with:
|
||
- A clear title
|
||
- Steps to reproduce (for bugs)
|
||
- Expected vs actual behavior
|
||
|
||
## License
|
||
|
||
By contributing, you agree that your contributions will be licensed under the MIT License. |