This repo is a fork of a fork of Travis Jocko, our goal is to maintain and update the project while Travis is on his hiatus.
When creating a pull-request you should:
-
Open an issue first:
- Confirm that the change will be accepted
- Describe in bullet points what your change does and why it's useful
- Link the equivalent code from the Kafka repo or docs.
-
Fork and clone the repo:
git clone [email protected]:your-username/jocko.git -
Get the deps:
dep ensure(If you don't have dep, run:
go get -u github.com/golang/dep/cmd/dep) -
Check the tests pass:
go test ./... -
Make your change
-
Write tests and check they pass
-
Lint your code: Use
gofmt,golint, andgovetto clean up your code -
Start your commit message with a verb: your commit message must start a lowercase verb such as: "add", "fix", "refactor", "remove"
-
Reference the issue: Reference your issue N by including "closes #N" in the commit message
Thanks!