Found a problem? Have a question? open an issue.
We also love pull requests from everyone, feel free to open one, but remember to follow the guidelines:
-
Double check the roadmap, there might be someone already working on similar tasks.
-
Fork, then clone the repo:
git clone [email protected]:your-username/voik.git
- Set up your machine:
make build
- Make sure the tests pass:
make test
- Make your changes. Add tests for your changes. Make the tests pass:
make test
ProTip: you can use make test_watcher to run the tests on every change.
- Push to your fork and submit a pull request.
At this point you're waiting on us. We may suggest some changes or improvements or alternatives.
Some things that will increase the chance that your pull request is accepted:
- Write tests.
- Make sure performance is not degraded.
- Follow our style guide.
- Write a good commit message.
- Rebase against master.