Thank you for your interest in contributing to this project! We welcome contributions from the community to help improve and grow this project. Before getting started, please take a moment to read and understand these guidelines to ensure a smooth and effective contribution process.
If you encounter a bug or issue with the project, please follow these steps:
- Check the GitHub issue tracker to ensure the issue hasn't already been reported.
- If it hasn't been reported, create a new issue with a clear and concise description of the problem, including any error messages and steps to reproduce the issue.
If you have ideas for improvements or enhancements, please follow these steps:
- Check the GitHub issue tracker to see if a similar suggestion has already been made.
- If not, create a new issue with a detailed explanation of your suggestion and why you believe it would be beneficial.
If you'd like to contribute code to the project, please follow these steps:
- Fork the repository on GitHub.
- Clone your forked repository to your local machine.
- Create a new branch for your feature or bug fix:
git checkout -b feature/your-feature. - Make your changes, following our coding guidelines.
- Ensure your code passes all tests.
- Commit your changes with clear and concise commit messages.
- Push your branch to your forked repository on GitHub:
git push origin feature/your-feature. - Create a pull request against the
mainbranch of the original repository.
To get started with the project, you can follow the instructions in the README.md and LEARN.md file.
Make sure to run tests to ensure that your changes do not break existing functionality.
If everything is fine, go ahead and create a Pull Request
All contributions go through a code review process. Be prepared to address feedback and make necessary changes to your code to meet project standards.