diff options
| author | Michael DeHaan <michael.dehaan@gmail.com> | 2012-09-18 04:55:06 +0200 |
|---|---|---|
| committer | Michael DeHaan <michael.dehaan@gmail.com> | 2012-09-18 04:55:06 +0200 |
| commit | a478e5c981e3fc0505337cb9c0c4523fb5343d60 (patch) | |
| tree | 95097629f75074e9f4bb5afe0e5f26fee204d8b9 /CONTRIBUTING.md | |
| parent | Add CONTRIBUTING doc since github now supports this. (diff) | |
| download | ansible-a478e5c981e3fc0505337cb9c0c4523fb5343d60.tar.xz ansible-a478e5c981e3fc0505337cb9c0c4523fb5343d60.zip | |
update contributing file
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 25 |
1 files changed, 24 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index aecf861488..7979d757d7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,11 +1,13 @@ Contributing to Ansible ======================= -Please read the following information to learn how to contribute to this project. +It is required that you read the following information to learn how to contribute to this project. Branch Info =========== +Here's how to understand the branches. + * The devel branch corresponds to the latest ongoing release * Various release-X.Y branches exist for previous releases * All feature work happens on the development branch. @@ -31,6 +33,27 @@ Contributions to the core and modules are greatly welcome. * Sending patches to the mailing list directly. * Sending feature pull requests to the 'release' branch instead of the devel branch * Sending pull requests to mpdehaan's personal ansible fork. + * Sending pull requests about more than one feature in the same pull request. + * Whitespace restructuring + * Large scale refactoring without a discussion on the list + +Coding Standards +================ + +We're not too strict on style considerations, but we require: + + * python 2.6 compliant code, unless in ansible modules, then python *2.4* compliant code (no 'with', etc) + * 4-space indents, no tabs except in Makefiles + * under_scores for method names and variables, not camelCase + * GPLv3 license headers on all files, with copyright on new files with your name on it + * no single-line if statements, deeply nested list comprehensions, or clever use of metaclasses -- keep it simple + * comments where appropriate + +Contributors License Agreement +============================== + +By contributing you agree that these contributions are your own (or approved by your employer) and you grant a full, complete, irrevocable +copyright license to all users and developers of the project, present and future, persusant to the license of the project. |