1.4 KiB
1.4 KiB
Contribution Guidelines
Thank you for considering contributing to this project! Your involvement helps make this project better for everyone.
How to Contribute
- Fork the repository
- Create a new feature branch
git checkout -b feature/your-feature-name - Make your changes
Write clean, well-documented code. Follow the project’s coding standards. - Add tests
All new features or bug fixes must include appropriate unit or integration tests. - Commit your changes
Use descriptive commit messages following Conventional Commits. - Push to your fork
git push origin feature/your-feature-name - 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 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.