This is a short guide on how to contribute to the project.
If you find a bug that you'd like to fix, or a new feature that you'd like to implement then please submit a pull request via Github.
You'll need a Go environment set up with GOPATH set. See the Go getting started docs for more info.
Now in your terminal
git clone ssh://[email protected]/kenjones-cisco/dinamo.git
cd dinamo
Make a branch to add your new feature
git checkout -b my-new-feature master
And get hacking.
When ready - run the unit tests for the code you changed
make test
Make sure you
- Add documentation for a new feature
- Add unit tests for a new feature
- squash commits down to one per feature
- rebase to master
git rebase master
When you are done with that
git push origin my-new-feature
Go to the Github website and click Create pull request.
You patch will get reviewed and you might get asked to fix some stuff.
If so, then make the changes in the same branch, squash the commits, rebase it to master then push it to Github with --force.
Tests are run using a testing framework, so at the top level you can run this to run all the tests.
Assumes that you have Minishift / Docker Toolbox / Docker for Mac / Docker for Windows installed.
# runs all tests (includes formatting and linting)
make test
make local test
# run all tests and generates code coverage (includes formatting and linting)
make cover
make local cover
# builds the default binary (linux amd64); (includes formatting and linting)
make build
make local build