Thank you for considering contributing to this project. This document outlines the process and guidelines for contributing.
- Fork the repository on GitHub.
- Clone the forked repository to your local machine.
- Navigate to the project directory and install the required dependencies.
- Create a new branch for your feature, bugfix, or improvement.
- Make sure all tests pass and there are no linting errors in your code.
- Commit your changes in a meaningful manner.
- Push your branch to your fork.
- Open a pull request from your branch to the project's
masterormainbranch. - Describe the changes you've made in detail and reference any issues it addresses.
Note: Before submitting a pull request, ensure that your changes merge cleanly with the master or main branch.
- Follow the style of the existing code.
- Include comments to explain the purpose and reasoning behind significant pieces of code.
- Write descriptive commit messages.
- Use the issue tracker to report bugs or suggest features.
- Before submitting a new issue, please search to see if someone has already reported the same issue.
- Include as much information as possible in your report: steps to reproduce the bug, error messages, your operating system/version, etc.
If you have any questions, join our discussions.
Thank you again for considering contributing to our project!