Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
We recommend opening an issue before a substantial Pull Request if there isn’t already an issue for what you’d like to contribute. This helps facilitate a discussion before deciding on an implementation approach.
For some changes, such as typo fixes, documentation enhancements, or broken links, it may be suitable to open a small Pull Request by itself.
- Check the issues or open a new one
- Fork this repository
- Create your feature branch:
git checkout -b my-new-feature - Commit your changes:
git commit -am 'feat: Add some feature' - Push to the branch:
git push origin my-new-feature - Submit a pull request linked to the issue 1.
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
- Follow the overall style of the project
- Write tests
- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, submit them as separate pull requests
- Write good commit messages following conventional commits
- Open a pull request with a title following conventional commits
You can find a Makefile with steps for running tests agains a locally deployed Artifactory instance using docker.
Run command make test
Run command make clean
By sending us your contributions, you are agreeing that your contribution is made subject to the terms of our Contributor Ownership Statement