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

Update CONTRIBUTING.md

Browse source
This commit is contained in:
Michael DeHaan 2013-12-15 11:53:54 -05:00
parent 7ff430f461
commit f96f69ece3
1 changed files with 9 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
CONTRIBUTING.md
View file

@ -56,9 +56,14 @@ The Ansible project keeps it’s source on github at
and takes contributions through and takes contributions through
[github pull requests](https://help.github.com/articles/using-pull-requests). [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 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 “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 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 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 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. 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 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 * A succint description of the problem
* What version of ansible you are using (ansible --version) * 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 * 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 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. for IRC or the mailing list instead where things are likely to be more of a discussion.