Add Code of Conduct and Contribution Guidelines (segmentio#699)

* Add Code of Conduct and 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 segmentio#688 * Update steps for git push * Update based on PR comments Removed several linkable sections in the Code of Conduct. Update contributing to use kafka-go consistently. Finished explaining how to replace the original version with forked version of the library. * Update based on further feedback * Adjust to follow the twilio-go code of contact
jiujuan · Sep 14, 2021 · 9458e25 · 9458e25
1 parent a63af32
commit 9458e25
Show file tree

Hide file tree

Showing 2 changed files with 214 additions and 0 deletions.
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,75 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+Project maintainers are available at [#kafka-go](https://gophers.slack.com/archives/CG4H0N9PX) channel inside the [Gophers Slack](https://gophers.slack.com)
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at open-source@twilio.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
diff --git a/CONTRIBUTING.md b/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 git@github.com: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
+    ```