diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index aa201cae72c..c8c894c261e 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,7 +1,6 @@ # Bug reporting -A good bug report has some very specific qualities, so please read over our short document on -[reporting bugs][report_bugs] before you submit your bug report. +A good bug report has some very specific qualities, so please read over our short document on [reporting bugs][report_bugs] before submitting a bug report. To ask a question, go ahead and ignore this. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 736f3f2d694..635f73a3056 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # How to contribute -etcd is Apache 2.0 licensed and accepts contributions via GitHub pull requests. This document outlines some of the conventions on commit message formatting, contact points for developers and other resources to make getting your contribution into etcd easier. +etcd is Apache 2.0 licensed and accepts contributions via GitHub pull requests. This document outlines some of the conventions on commit message formatting, contact points for developers, and other resources to help get contributions into etcd. # Email and chat @@ -14,24 +14,20 @@ etcd is Apache 2.0 licensed and accepts contributions via GitHub pull requests. ## Reporting bugs and creating issues -Reporting bugs is one of the best ways to contribute. However, a good bug report -has some very specific qualities, so please read over our short document on -[reporting bugs](https://github.com/coreos/etcd/blob/master/Documentation/reporting_bugs.md) -before you submit your bug report. This document might contain links known -issues, another good reason to take a look there, before reporting your bug. +Reporting bugs is one of the best ways to contribute. However, a good bug report has some very specific qualities, so please read over our short document on [reporting bugs](https://github.com/coreos/etcd/blob/master/Documentation/reporting_bugs.md) before submitting a bug report. This document might contain links to known issues, another good reason to take a look there before reporting a bug. ## Contribution flow This is a rough outline of what a contributor's workflow looks like: -- Create a topic branch from where you want to base your work. This is usually master. +- Create a topic branch from where to base the contribution. This is usually master. - Make commits of logical units. -- Make sure your commit messages are in the proper format (see below). -- Push your changes to a topic branch in your fork of the repository. +- Make sure commit messages are in the proper format (see below). +- Push changes in a topic branch to a personal fork of the repository. - Submit a pull request to coreos/etcd. -- Your PR must receive a LGTM from two maintainers found in the MAINTAINERS file. +- The PR must receive a LGTM from two maintainers found in the MAINTAINERS file. -Thanks for your contributions! +Thanks for contributing! ### Code style @@ -48,8 +44,7 @@ the body of the commit should describe the why. ``` scripts: add the test-cluster command -this uses tmux to setup a test cluster that you can easily kill and -start for debugging. +this uses tmux to setup a test cluster that can easily be killed and started for debugging. Fixes #38 ``` @@ -64,7 +59,4 @@ The format can be described more formally as follows: