Skip to content

Commit

Permalink
update contributing
Browse files Browse the repository at this point in the history
  • Loading branch information
travisjeffery committed Dec 12, 2016
1 parent 6a5d11f commit b9ddd2c
Showing 1 changed file with 27 additions and 36 deletions.
63 changes: 27 additions & 36 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,34 @@
# Contributing to Jocko

Thank you for contributing to Jocko!

Here's the [ROADMAP](https://github.com/travisjeffery/jocko/issues/1) where you'll find what could be worked on. The current goal is feature parity with Kafka 0.10.x.

Here's the steps to contribute:

## Fork and clone the repo:

```
git clone git@github.com:your-username/jocko.git
```

## Get the deps:

```
govendor sync
```

- (If you don't have govendor, run: `go get -u github.com/kardianos/govendor`)


## Check the tests pass:

```
go test ./...
```

## Make your change. Write tests. Make the tests pass:

```
go test ./...
```

## [Write a good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).

## Push to your fork. Submit a pull request.
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](https://github.com/apache/kafka) or [docs](https://kafka.apache.org/documentation).
- **Fork and clone the repo**:
```
git clone git@github.com:your-username/jocko.git
```

- **Get the deps**:
```
govendor sync
```
(If you don't have govendor, run: `go get -u github.com/kardianos/govendor`)

- **Check the tests pass**:
```
go test ./...
```

- **Make your change**
- **Write tests and check they pass**
- **Lint your code**: Use `gofmt`, `golint`, and `govet` to 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

- Describe in bullet points what your change does and why.
- Link the equivalent code from the [Kafka repo](https://github.com/apache/kafka) or [docs](https://kafka.apache.org/documentation).

Thanks!

0 comments on commit b9ddd2c

Please sign in to comment.