diff options
| author | Michael DeHaan <michael.dehaan@gmail.com> | 2013-12-15 11:53:54 -0500 |
|---|---|---|
| committer | Michael DeHaan <michael.dehaan@gmail.com> | 2013-12-15 11:53:54 -0500 |
| commit | f96f69ece315debf828ebf6e94f3abf453d6ecb2 (patch) | |
| tree | f5b1b5a1e04ab4543f712679c366631a8d8300d0 /CONTRIBUTING.md | |
| parent | 7ff430f461f5772f7d559475201279903fc8ba55 (diff) | |
| download | ansible-f96f69ece315debf828ebf6e94f3abf453d6ecb2.tar.gz | |
Update CONTRIBUTING.md
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 13 |
1 files changed, 9 insertions, 4 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0d162be928..fe683efb06 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -56,9 +56,14 @@ The Ansible project keeps it’s source on github at and takes contributions through [github pull requests](https://help.github.com/articles/using-pull-requests). +It is usually a good idea to join the ansible-devel list to discuss any large features prior to submission, and this +especially helps in avoiding duplicate work or efforts where we decide, upon seeing a pull request for the first +time, that revisions are needed. (This is not usually needed for module development) + When submitting patches, be sure to run the unit tests first “make tests” and always use “git rebase” vs “git merge” (aliasing git pull to git pull --rebase is a great idea) to -avoid merge commits in your submissions. +avoid merge commits in your submissions. We will require resubmission of pull requests that +contain merge commits. We’ll then review your contributions and engage with you about questions and so on. Please be advised we have a very large and active community, so it may take awhile to get your contributions @@ -84,14 +89,14 @@ Bugs should be reported to [github.com/ansible/ansible](http://github.com/ansibl signing up for a free github account. Before reporting a bug, please use the bug/issue search to see if the issue has already been reported. -When filing a bug, the following information is required: +When filing a bug, the following information is always required: * A good name for the bug ("Foo module raises exception when xyz=glork is used", vs "foo doesn't work") * A succint description of the problem * What version of ansible you are using (ansible --version) -* Steps to reproduce the problem +* Steps to reproduce the problem, including commands or playbook snippets as relevant * Expected results -* Actual results +* Actual results, and as full/complete output as possible Do not use the issue tracker for "how do I do this" type questions. These are great candidates for IRC or the mailing list instead where things are likely to be more of a discussion. |