summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorMichael DeHaan <michael.dehaan@gmail.com>2012-09-17 22:42:32 -0400
committerMichael DeHaan <michael.dehaan@gmail.com>2012-09-17 22:42:32 -0400
commit086400cde01a21976fcf70e56ca1ed3b7f7faada (patch)
treeebfd3b541d1c614d46dc13b22eac6a3e0259e350 /CONTRIBUTING.md
parentd77be4eecfda0c1cb88fec9bd88d0dd669a54642 (diff)
downloadansible-086400cde01a21976fcf70e56ca1ed3b7f7faada.tar.gz
Add CONTRIBUTING doc since github now supports this.
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000000..aecf861488
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,36 @@
+Contributing to Ansible
+=======================
+
+Please read the following information to learn how to contribute to this project.
+
+Branch Info
+===========
+
+ * 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.
+ * Major bug fixes will be made to the last release branch only
+ * See CHANGELOG.md for release notes to track each release.
+
+Patch Instructions
+==================
+
+Contributions to the core and modules are greatly welcome.
+
+ * Required Process:
+ * Submit github pull requests to the "ansible/devel" branch for features
+ * Fixes for bugs may also be submitted to "ansible/release-X.Y" for the last release
+ * Make sure "make tests" passes before submitting any requests.
+ * Bonus points:
+ * Joining the mailing list
+ * Fixing bugs instead of sending bug reports.
+ * Using squash merges
+ * Updating the "rst/*" files in the docs project and "docs/" manpage content
+ * Adding more unit tests
+ * Avoid:
+ * 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.
+
+
+