Skip to content

Latest commit

 

History

History
139 lines (96 loc) · 4.63 KB

CONTRIBUTING.md

File metadata and controls

139 lines (96 loc) · 4.63 KB
Raw

Contributing to kafka-go

kafka-go is an open source project. We welcome contributions to kafka-go of any kind including documentation, organization, tutorials, bug reports, issues, feature requests, feature implementations, pull requests, etc.

Table of Contents

Reporting Issues

If you believe you have found a defect in kafka-go, use the GitHub issue tracker to report the problem to the maintainers.
When reporting the issue, please provide the version of kafka-go, what version(s) of Kafka are you testing against, and your operating system.

Submitting Patches

kafka-go project welcomes all contributors and contributions regardless of skill or experience levels. If you are interested in helping with the project, we will help you with your contribution.

Code Contribution

To make contributions as seamless as possible, we ask the following:

  • Go ahead and fork the project and make your changes. We encourage pull requests to allow for review and discussion of code changes.
  • When you’re ready to create a pull request, be sure to:
    • Have test cases for the new code. If you have questions about how to do this, please ask in your pull request.
    • Run go fmt.
    • Squash your commits into a single commit. git rebase -i. It’s okay to force update your pull request with git push -f.
    • Follow the Git Commit Message Guidelines below.

Git Commit Message Guidelines

This blog article is a good resource for learning how to write good commit messages, the most important part being that each commit message should have a title/subject in imperative mood starting with a capital letter and no trailing period: "Return error on wrong use of the Reader", NOT "returning some error."

Also, if your commit references one or more GitHub issues, always end your commit message body with See #1234 or Fixes #1234. Replace 1234 with the GitHub issue ID. The last example will close the issue when the commit is merged into master.

Please use a short and descriptive branch name, e.g. NOT "patch-1". It's very common but creates a naming conflict each time when a submission is pulled for a review.

An example:

Add Code of Conduct and Code Contribution Guidelines

Add a full Code of Conduct and Code Contribution Guidelines document. 
Provide description on how best to retrieve code, fork, checkout, and commit changes.

Fixes #688

Fetching the Sources From GitHub

We use Go Modules support built into Go 1.11 to build. The easiest way is to clone kafka-go into a directory outside of GOPATH, as in the following example:

mkdir $HOME/src
cd $HOME/src
git clone https://github.com/segmentio/kafka-go.git
cd kafka-go
go build ./...

To make changes to kafka-go's source:

  1. Create a new branch for your changes (the branch name is arbitrary):

    git checkout -b branch1234

  2. After making your changes, commit them to your new branch:

    git commit -a -v

  3. Fork kafka-go in GitHub

  4. Add your fork as a new remote (the remote name, "upstream" in this example, is arbitrary):

    git remote add upstream git@github.com:USERNAME/kafka-go.git

  5. Push your branch (the remote name, "upstream" in this example, is arbitrary):

    git push upstream

  6. You are now ready to submit a PR based upon the new branch in your forked repository.

Using the forked library

To replace the original version of kafka-go library with a forked version is accomplished this way.

  1. Make sure your application already has a go.mod entry depending on kafka-go

    module github.com/myusername/myapp

require (
    ...
    github.com/segmentio/kafka-go v1.2.3
    ...
)

  2. Add the following entry to the beginning of the modules file.

    module github.com/myusername/myapp

replace github.com/segmentio/kafka-go v1.2.3 => ../local/directory

require (
    ...
    github.com/segmentio/kafka-go v1.2.3
    ...
)

  3. Depending on if you are using vendoring or not you might need to run the following command to pull in the new bits.

    > go mod vendor