- Ensure you have minimum version 1.15 of go installed.
- Ensure you have minimum version 5.7 of mysql installed.
- After fork the repository, you may start your development.
If you have decided to contribute code back to upstream by opening a pull request. You've invested a good chunk of time, and we appreciate it. We will do our best to work with you and get the PR looked at.
Working on your first Pull Request? You can learn how from this free video series:
How to Contribute to an Open Source Project on GitHub
If you would like to request a new feature or enhancement but are not yet thinking about opening a pull request, you can also file an issue with feature template.
If you're only fixing a bug, it's fine to submit a pull request right away but we still recommend that you file an issue detailing what you're fixing. This is helpful in case we don't accept that specific fix but want to keep track of the issue.
Small pull requests are much easier to review and more likely to get merged. Make sure the PR does only one thing, otherwise please split it by module.
Please make sure the following is done when submitting a pull request:
- Fork the repository and create your branch from main.
- Describe your test plan in your pull request description. Make sure to test your changes.
- Make sure your tests pass
go test ./.... - All pull requests should be opened against the main branch.
For testing, we are using package github.com/stretchr/testify, please ensure you use the same package for your unit testing as well.
By contributing to sqlike, you agree that your contributions will be licensed under its MIT license.