Thank you for considering contributing to this project! We appreciate any contribution you can make to this project, whether it's reporting a bug, requesting a feature, improving the code, or polishing the documentation. To ensure that everything runs smoothly, please review the guidelines below before submitting your contribution:
We welcome any contributions that help improve this project. Here are some examples of the kinds of contributions we are looking for:
- Bug reports and feature requests
- Code improvements and bug fixes
- Design and performance improvements
- Documentation improvements
If you are uncertain about whether your contribution aligns with the scope of this project, please refer to the What We Do Not Want section. Feel free to reach out to the maintainers, if you have any questions.
While we appreciate all contributions that help improve this project, some may not align with our vision, require further discussion, or may be better suited for a fork. Here are some examples that may fall into this category:
- Plagiarism
- Features exceeding final project deadline
If you are uncertain about whether your contribution aligns with the scope of this project, please refer to the What We Want section. Feel free to reach out to the maintainers, if you have any questions.
Contributions to this project are welcome! To ensure consistency and quality, please adhere to the following guidelines when submitting changes:
To submit changes to this repository, please follow these steps:
- Fork the repository
- Create a new branch on your fork
- Make and push your changes to the forked repository
- Submit a pull request to the main repository
Please make sure to include a clear and concise description of your changes in your pull request.
This project uses the Commitizen commit
standards to ensure consistent commit messages. If you're unfamiliar with all
the supported tags, it is recommended to use the git cz command, which will prompt you to
enter a commit message in the proper format.
To maintain a respectful community, please review our code of conduct.
This project is licensed under MIT.