First of all, thank you for considering contributing to this project! 🎉
Please review and adhere to our Code of Conduct before contributing.
- Fork the repository.
- Create a new branch with a descriptive name:
git checkout -b feature/your-feature
orgit checkout -b bugfix/your-bugfix
. - Make your changes and commit them:
git commit -m 'Description of your changes'
. (Would be better if you use Conventional Commits for commit messages) - Push your changes to your fork:
git push origin feature/your-feature
. - Open a pull request against the
main
branch of the original repository.
-
Clearly describe the problem or feature.
-
Ensure your code is well-documented.
-
Ensure your code follows the project's coding standards. To make sure the project is using the correct formatting you and use these commands:
make fmt lint
-
Include any necessary tests for your changes.
- For feature requests or bug reports, open an issue and use the appropriate template.
Thank you for contributing! 🚀