Add Code of Conduct and Contribution Guidelines

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Code of Conduct
+
+## 1. Purpose
+
+A primary goal of kafka-go is to be inclusive to the largest number of contributors, with the most varied and diverse backgrounds possible. As such, we are committed to providing a friendly, safe and welcoming environment for all, regardless of gender, sexual orientation, ability, ethnicity, socioeconomic status, and religion (or lack thereof).
+
+This code of conduct outlines our expectations for all those who participate in our community, as well as the consequences for unacceptable behavior.
+
+We invite all those who participate in kafka-go to help us create safe and positive experiences for everyone.
+
+## 2. Open Source Citizenship
+
+A supplemental goal of this Code of Conduct is to increase open source citizenship by encouraging participants to recognize and strengthen the relationships between our actions and their effects on our community.
+
+Communities mirror the societies in which they exist and positive action is essential to counteract the many forms of inequality and abuses of power that exist in society.
+
+If you see someone who is making an extra effort to ensure our community is welcoming, friendly, and encourages all participants to contribute to the fullest extent, we want to know.
+
+## 3. Expected Behavior
+
+The following behaviors are expected and requested of all community members:
+
+* Participate in an authentic and active way. In doing so, you contribute to the health and longevity of this community.
+* Exercise consideration and respect in your speech and actions.
+* Attempt collaboration before conflict.
+* Refrain from demeaning, discriminatory, or harassing behavior and speech.
+* Be mindful of your surroundings and of your fellow participants. Alert community leaders if you notice a dangerous situation, someone in distress, or violations of this Code of Conduct, even if they seem inconsequential.
+* Remember that community event venues may be shared with members of the public; please be respectful to all patrons of these locations.
+
+## 4. Unacceptable Behavior
+
+The following behaviors are considered harassment and are unacceptable within our community:
+
+* Violence, threats of violence or violent language directed against another person.
+* Sexist, racist, homophobic, transphobic, ableist or otherwise discriminatory jokes and language.
+* Posting or displaying sexually explicit or violent material.
+* Posting or threatening to post other people's personally identifying information ("doxing").
+* Personal insults, particularly those related to gender, sexual orientation, race, religion, or disability.
+* Inappropriate photography or recording.
+* Inappropriate physical contact. You should have someone's consent before touching them.
+* Unwelcome sexual attention. This includes, sexualized comments or jokes; inappropriate touching, groping, and not welcome sexual advances.
+* Deliberate intimidation, stalking or following (online or in person).
+* Advocating for, or encouraging, any of the above behavior.
+* Sustained disruption of community events, including talks and presentations.
+
+## 5. Consequences of Unacceptable Behavior
+
+Unacceptable behavior from any community member, including sponsors and those with decision-making authority, will not be tolerated.
+
+Anyone asked to stop unacceptable behavior is expected to comply immediately.
+
+If a community member engages in unacceptable behavior, the community organizers may take any action they deem appropriate, up to and including a temporary ban or permanent expulsion from the community without warning (and without refund in the case of a paid event).
+
+## 6. Reporting Guidelines
+
+If you are subject to or witness unacceptable behavior, or have any other concerns, please notify a community organizer as soon as possible. Community organizers can be found on the [#kafka-go](https://gophers.slack.com/archives/CG4H0N9PX).
+
+Additionally, community organizers are available to help community members engage with local law enforcement or to otherwise help those experiencing unacceptable behavior feel safe. In the context of in-person events, organizers will also provide escorts as desired by the person experiencing distress.
+
+## 7. Scope
+
+We expect all community participants (contributors, paid or otherwise; sponsors; and other guests) to abide by this Code of Conduct in all community venues--online and in-person--as well as in all one-on-one communications pertaining to community business.
+
+This code of conduct and its related procedures also applies to unacceptable behavior occurring outside the scope of community activities when such behavior has the potential to adversely affect the safety and well-being of community members.
+
+## 8. Contact info
+
+Community Organizer are available at [#kafka-go](https://gophers.slack.com/archives/CG4H0N9PX)
+
+## 11. License and attribution
+
+The Citizen Code of Conduct is distributed by the community organizers of kafka-go under a [Creative Commons Attribution-ShareAlike license](http://creativecommons.org/licenses/by-sa/3.0/).
+
+Portions of text derived from the [Django Code of Conduct](https://www.djangoproject.com/conduct/), the [Geek Feminism Anti-Harassment Policy](http://geekfeminism.wikia.com/wiki/Conference_anti-harassment/Policy), and the [Stumptown Syndicate](https://github.com/stumpsyn/policies/blob/master/citizen_code_of_conduct.md).
+
+

CONTRIBUTING.md

@@ -0,0 +1,139 @@
+# 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](#reporting-issues)
+* [Submitting Patches](#submitting-patches)
+  * [Code Contribution Guidelines](#code-contribution-guidelines)
+  * [Git Commit Message Guidelines](#git-commit-message-guidelines)
+  * [Fetching the Source From GitHub](#fetching-the-sources-from-github)
+  * [Building kafka-go with Your Changes](#building-kakfa-go-with-your-changes)
+
+## 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.
+
+ - [kafka-go Issues segmentio/kafka-go](https://github.com/segmentio/kafka-go/issues)
+
+## 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](http://chris.beams.io/posts/git-commit/) 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:
+
+```text
+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:
+
+```bash
+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):
+
+    ```bash
+    git checkout -b branch1234
+    ```
+
+1. After making your changes, commit them to your new branch:
+
+    ```bash
+    git commit -a -v
+    ```
+
+1. Fork kafka-go in GitHub
+
+1. Add your fork as a new remote (the remote name, "upstream" in this example, is arbitrary):
+
+    ```bash
+    git remote add upstream [email protected]:USERNAME/kafka-go.git
+    ```
+
+1. Push your branch (the remote name, "upstream" in this example, is arbitrary):
+
+   ```bash
+   git push upstream  
+   ```
+
+1. 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
+
+    ```bash
+    module github.com/myusername/myapp
+
+    require (
+        ...
+        github.com/segmentio/kafka-go v1.2.3
+        ...
+    )
+    ```
+
+1. Add the following entry to the beginning of the modules file.
+
+    ```bash
+    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
+        ...
+    )
+    ```
+1. Depending on if you are using `vendor`ing or not you might need to run the following command to pull in the new bits.
+
+    ```bash
+    > go mod vendor
+    ```