Thank you for considering contributing to our open-source project! We appreciate your interest and support. To ensure a smooth collaboration, please follow these guidelines:
- Fork the repository and clone it to your local machine.
- Create a new branch for your changes:
git checkout -b feature/your-feature. - Make your desired changes and test them thoroughly.
- Commit your changes:
git commit -m "Add your commit message here". - Push your changes to your forked repository:
git push origin feature/your-feature. - Open a pull request to the main repository.
- Follow the existing code style and conventions.
- Use meaningful variable and function names.
- Write clear and concise comments.
- For now, we don't have any tests, but we are working on it. If you want to help us with that, you are welcome.
- Update the project's documentation if necessary.
- Provide clear and comprehensive explanations for new features or changes.
- If you encounter any issues or bugs, please report them using the issue tracker.
- Include steps to reproduce the issue and any relevant information.
Please adhere to our Code of Conduct throughout your participation in this project.
We appreciate your contributions and look forward to your involvement in making this project better!