Thank you for considering contributing to our project! We appreciate your interest and contributions.
To get started, please follow these steps:
- Fork the repository: Click the "Fork" button on the top right corner of the repository page.
- Clone the repository: Clone your forked repository to your local machine.
- Install dependencies: Follow the instructions in the README to install any necessary dependencies.
- Create a new branch: For each set of changes, create a new branch from
main. - Make your changes: Implement your changes and ensure they adhere to our coding standards.
- Write tests: Write tests to cover your changes.
- Commit changes: Commit your changes with clear and concise commit messages.
- Push changes: Push your changes to your forked repository.
- Open a Pull Request: Open a Pull Request (PR) from your branch to the
mainbranch of the original repository.
Please read and follow our Code of Conduct to ensure a welcoming and respectful environment for all contributors.
If you find a bug, please report it by following these steps:
- Ensure the issue has not already been reported.
- Provide detailed information about the bug, including steps to reproduce it.
- Open an issue in the repository and tag it with
bug.
When submitting patches, please ensure they are well-documented and include tests. Follow our coding standards and ensure your code is clean and maintainable.
For any questions or concerns, please open an issue in the Issue Section.
Thank you for your contributions!