cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

update contributing file

Browse source
This commit is contained in:
Michael DeHaan 2012-09-17 22:55:06 -04:00
parent 086400cde0
commit a478e5c981
1 changed files with 24 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
CONTRIBUTING.md
View file

@ -1,11 +1,13 @@
Contributing to Ansible 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 Branch Info
=========== ===========
Here's how to understand the branches.
* The devel branch corresponds to the latest ongoing release * The devel branch corresponds to the latest ongoing release
* Various release-X.Y branches exist for previous releases * Various release-X.Y branches exist for previous releases
* All feature work happens on the development branch. * 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 patches to the mailing list directly.
* Sending feature pull requests to the 'release' branch instead of the devel branch * 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 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.