2013-09-30 23:10:56 +04:00
# How to contribute
2014-04-04 21:58:34 +04:00
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.
2013-09-30 23:10:56 +04:00
# Email and chat
2014-04-04 21:58:34 +04:00
- Email: [etcd-dev ](http://coreos.com/lists/etcd-dev/ )
2013-09-30 23:24:50 +04:00
- IRC: #[coreos](irc://irc.freenode.org:6667/#coreos) IRC channel on freenode.org
2013-09-30 23:10:56 +04:00
2014-04-04 21:58:34 +04:00
## Getting started
2013-09-30 23:10:56 +04:00
- Fork the repository on GitHub
- Read the README.md for build instructions
## 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.
- Make commits of logical units.
2014-04-04 21:58:34 +04:00
- Make sure your commit messages are in the proper format (see below).
2013-09-30 23:10:56 +04:00
- Push your changes to a topic branch in your fork of the repository.
2014-04-04 21:58:34 +04:00
- Submit a pull request to coreos/etcd.
2013-09-30 23:10:56 +04:00
2014-04-04 21:58:34 +04:00
Thanks for your contributions!
2013-09-30 23:10:56 +04:00
2014-03-07 01:38:20 +04:00
### Code style
2014-03-07 02:12:51 +04:00
The coding style suggested by the Golang community is used in etcd. See [style doc ](https://code.google.com/p/go-wiki/wiki/Style ) for details.
2014-03-07 01:38:20 +04:00
2014-03-07 02:12:51 +04:00
Please follow this style to make etcd easy to review, maintain and develop.
2014-03-07 01:38:20 +04:00
2013-09-30 23:10:56 +04:00
### Format of the commit message
2014-04-04 21:58:34 +04:00
etcd follows a rough convention for commit messages borrowed from Angularjs. This is an example of a commit:
2013-09-30 23:10:56 +04:00
```
feat(scripts/test-cluster): add a cluster test command
this uses tmux to setup a test cluster that you can easily kill and
start for debugging.
```
2014-04-04 21:58:34 +04:00
The format can be more formally described as follows:
2013-09-30 23:10:56 +04:00
```
< type > (< scope > ): < subject >
< BLANK LINE >
< body >
< BLANK LINE >
< footer >
```
2014-04-04 21:58:34 +04:00
The first line is the subject and should be no longer than 70 characters, the second line is always blank, and other lines should be wrapped at 80 characters. This allows the message to be easier to read on github as well as
in various git tools.
2013-09-30 23:10:56 +04:00
### Subject line
2014-04-04 21:58:34 +04:00
The subject line contains a succinct description of the change.
2013-09-30 23:10:56 +04:00
2014-04-04 21:58:34 +04:00
### Allowed <type>s
2013-11-11 23:57:38 +04:00
- feat (feature)
- fix (bug fix)
- docs (documentation)
- style (formatting, missing semi colons, …)
- refactor
- test (when adding missing tests)
- chore (maintain)
2013-09-30 23:10:56 +04:00
2014-04-04 21:58:34 +04:00
### Allowed <scope>s
2013-09-30 23:10:56 +04:00
2014-04-04 21:58:34 +04:00
Scopes can be anything specifying the place of the commit change within the repository. For example, "store", "API", etc.
2013-09-30 23:10:56 +04:00
### More details on commits
For more details see the [angularjs commit style guide ](https://docs.google.com/a/coreos.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit# ).
