8 Contributing
8.1 How to contribute?
Any contributions you make are greatly appreciated. You can contribute to this project in the following ways.
-
Add new functionality
If you would like to add some new functionality/features to the project, feel free to fork the project. If you are satisfied with your modification and would like to commit the changes to this project, you can follow the easy steps below -
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Review code
You can review the source code at GitHub repository. Your expert scrutiny may give us directions for any code optimization. You can propose your changes via GitHub issue.Raise issues about bugs/features/doubts
In case you found any bugs, want any new feature, or have any questions regarding the project, feel free to file a GitHub issue for the same.Proof-read the documentation
Despite our best efforts, there may be some typos, grammatical errors, and missing information in the documentation. You can use raise a GitHub issue for any changes sought.Cite if used in a publication
You can also cite this project if you are using it for your work. See Citation for more information.Star on GitHub
You can help increase the visibility of this project by starring the GitHub repository.Share with others
You can greatly help the reach by sharing the project links with others on social media. You can also review the project on your blog or social media post.
8.2 Code of Conduct
Please note that this project is released with a Contributor Code of Conduct. By contributing to this project you agree to abide by its terms.
8.3 Conventions followed
- Conventional Commits 1.0.0 for commit messages.
- Semantic Versioning 2.0.0 for release numbers.