Thank you for your interest in contributing to our project! This document provides guidelines and instructions for contributing.
By participating in this project, you are expected to uphold our Code of Conduct.
- Check if the bug has already been reported by searching the Issues.
- If the bug hasn't been reported, create a new issue with a clear title and description.
- Include steps to reproduce the bug, expected behavior, and actual behavior.
- Add screenshots or code snippets if helpful.
- Check if the enhancement has already been suggested by searching the Issues.
- If not, create a new issue with a clear title and detailed description.
- Explain why this enhancement would be useful to most users.
- Fork the repository.
- Create a new branch (
git checkout -b feature/amazing-feature). - Make your changes.
- Run tests to ensure your changes don't break existing functionality.
- Commit your changes (
git commit -m 'Add some amazing feature'). - Push to the branch (
git push origin feature/amazing-feature). - Open a Pull Request.
- Clone the repository.
- Install dependencies.
- Configure your development environment.
- Run tests to ensure everything is set up correctly.
- Follow the existing code style.
- Write clear, readable, and maintainable code.
- Add comments where necessary.
- Write tests for new functionality.
- Use clear and descriptive commit messages.
- Reference issues and pull requests when applicable.
By contributing to this project, you agree that your contributions will be licensed under the project's license.
Thank you for contributing!