From fd9ad4fa2c4ec91a5eec30428bc91644f6c25d77 Mon Sep 17 00:00:00 2001 From: Jonathan Boulle Date: Fri, 4 Apr 2014 10:58:34 -0700 Subject: [PATCH] docs(readme/contrib): clean up README, merge changes from CONTRIBUTING.md and split out DCO --- CONTRIBUTING.md | 33 ++++++++++------------- DCO | 36 +++++++++++++++++++++++++ README.md | 72 ++++++++++++++++++++++++------------------------- 3 files changed, 85 insertions(+), 56 deletions(-) create mode 100644 DCO diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 33d8c2355..cf3e65637 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,17 +1,13 @@ # How to contribute -etcd is open source, 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 make getting your contribution into etcd easier. # Email and chat -For simplicity etcd discussions happen on coreos-dev and in #coreos-dev. -As the community grows we will move to a dedicated mailing list and IRC channel. - -- Email: [coreos-dev](https://groups.google.com/forum/#!forum/coreos-dev) +- Email: [etcd-dev](http://coreos.com/lists/etcd-dev/) - IRC: #[coreos](irc://irc.freenode.org:6667/#coreos) IRC channel on freenode.org -## Getting Started +## Getting started - Fork the repository on GitHub - Read the README.md for build instructions @@ -22,11 +18,11 @@ 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. - Make commits of logical units. -- Make sure your commit messages are in the proper format, see below +- 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. -- Submit a pull request to coreos/etcd +- Submit a pull request to coreos/etcd. -Thanks for you contributions! +Thanks for your contributions! ### Code style @@ -36,8 +32,7 @@ Please follow this style to make etcd easy to review, maintain and develop. ### Format of the commit message -etcd follow a rough convention for commit messages borrowed from Angularjs. -This is an example of a commit: +etcd follows a rough convention for commit messages borrowed from Angularjs. This is an example of a commit: ``` feat(scripts/test-cluster): add a cluster test command @@ -46,7 +41,7 @@ This is an example of a commit: start for debugging. ``` -To make it more formal it looks something like this: +The format can be more formally described as follows: ``` (): @@ -56,14 +51,14 @@ To make it more formal it looks something like this: