CONTRIBUTING.md 12 KB
Newer Older
Michael DeHaan committed
1
Ansible Community  Information
Michael DeHaan committed
2
==============================
Michael DeHaan committed
3

Michael DeHaan committed
4 5 6
The purpose of the Ansible community is to  unite developers, system administrators, operations, and 
IT managers to share and build great automation solutions.  This document contains all sorts of 
information about how to contribute and interact with Ansible.  Welcome!
Michael DeHaan committed
7

Michael DeHaan committed
8 9 10
Ways to Interact
================

Michael DeHaan committed
11
There are a lot of ways to join and  be a part  of the  Ansible community, such as:
Michael DeHaan committed
12 13

Sharing Ansible with Others
Michael DeHaan committed
14
---------------------------
Michael DeHaan committed
15

Michael DeHaan committed
16 17
You can help share Ansible with others by telling friends and colleagues, writing a blog post, 
or presenting at user groups (like DevOps groups or the local LUG or BUG).  You are also 
Michael DeHaan committed
18 19
welcome to share slides on speakerdeck, sign up for a free account and tag it “Ansible”. On Twitter, 
you can also share things with #ansible and may wish 
Michael DeHaan committed
20
to follow [@Ansible](https://twitter.com/ansible).
Michael DeHaan committed
21

Michael DeHaan committed
22 23
Sharing Content and Tips
------------------------
24

Michael DeHaan committed
25 26 27
Join the [Ansible project mailing list](https://groups.google.com/forum/#!forum/ansible-project) and you 
can share playbooks you may have written and other interesting implementation stories. Put your Ansible 
content up on places like github  to share with others.
28

Michael DeHaan committed
29
Sharing A Feature Idea
Michael DeHaan committed
30
----------------------
31

Michael DeHaan committed
32 33 34
Ideas are very welcome and the best place to share them is the [Ansible project mailing list](https://groups.google.com/forum/#!forum/ansible-project) ([Subscribe](https://groups.google.com/forum/#!forum/ansible-project/join)) or #ansible on irc.freenode.net.

While you can file a feature request on GitHub, pull requests are a much better way to get your feature added than submitting a feature request.  Open source is all about itch scratching, and it's less likely that someone else will have the same itches as yourself.  We keep code reasonably simple on purpose so it's easy to dive in and make additions, but be sure to read the "Contributing Code" section below too -- as it doesn't hurt to have a discussion about a feature first -- we're inclined to have preferences about how incoming features might be implemented, and that can save confusion later.
35

Michael DeHaan committed
36
Helping with Documentation
Michael DeHaan committed
37
--------------------------
38

Michael DeHaan committed
39 40 41
Ansible documentation is a community project too!  If you would like to help with the 
documentation, whether correcting a typo or improving a section, or maybe even 
documenting a new feature, submit a github pull request to  the code that
arianitu committed
42
lives in the “docsite/rst” subdirectory of the project.   Docs are in restructured text
Michael DeHaan committed
43 44 45 46 47
format.  If you aren’t comfortable with restructured text, you can also open a ticket on 
github about any errors you spot or sections you would like to see added. For more information
on creating pull requests, please refer to the
[github help guide](https://help.github.com/articles/using-pull-requests).

48

Michael DeHaan committed
49 50
Contributing Code (Features or Bugfixes)
----------------------------------------
Michael DeHaan committed
51

Michael DeHaan committed
52 53 54 55
The Ansible project keeps it’s source on github at 
[github.com/ansible/ansible](http://github.com/ansible/ansible) 
and takes contributions through
[github pull requests](https://help.github.com/articles/using-pull-requests).
Michael DeHaan committed
56

Michael DeHaan committed
57 58 59 60 61
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)

Note that we do keep Ansible to a particular aesthetic, so if you are unclear about whether a feature
is a good fit or not, having the discussion on the development list is often a lot easier than having
to modify a pull request later.
Michael DeHaan committed
62

Michael DeHaan committed
63 64
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 
Michael DeHaan committed
65 66 67 68 69 70 71 72
avoid merge commits in your submissions.  There are also integration tests that can be run in the "tests/integration" directory.  

In order to keep the history clean and better audit incoming code, we will require resubmission of pull requests that contain merge commits.  Use "git pull --rebase" vs "git pull" and "git rebase" vs "git merge". Also be sure to use topic branches to keep your additions on different branches, such that they won't pick up stray commits later.

We’ll then review your contributions and engage with you about questions and  so on.  

As we have a very large and active community, so it may take awhile to get your contributions 
in!  See the notes about priorities in a later section for understanding our work queue.
Michael DeHaan committed
73

Michael DeHaan committed
74
Patches should be made against the 'devel' branch.
Michael DeHaan committed
75

Michael DeHaan committed
76 77
Contributions can be for new features like modules, or to fix bugs you or others have found. If you 
are interested in writing new modules to be included in the core Ansible distribution, please refer 
Michael DeHaan committed
78
to the [Module Developers documentation on our website](http://docs.ansible.com/developing_modules.html).
Michael DeHaan committed
79

Michael DeHaan committed
80 81 82 83
Ansible's aesthetic encourages simple, readable code and consistent, conservatively extending, 
backwards-compatible improvements.  Code developed for Ansible needs to support Python 2.6+, 
while code in modules must run under Python 2.4 or higher.  Please also use a 4-space indent
and no tabs.
Michael DeHaan committed
84

Michael DeHaan committed
85 86 87 88
Tip: To easily run from a checkout, source "./hacking/env-setup" and that's it -- no install
required.  You're now live!


Michael DeHaan committed
89
Reporting A Bug
Michael DeHaan committed
90
---------------
91

Michael DeHaan committed
92 93
Ansible practices responsible disclosure - if this is a security related bug, email security@ansible.com instead of filing a ticket or posting to the Google Group and you will recieve a prompt response.

Michael DeHaan committed
94
Bugs should be reported to [github.com/ansible/ansible](http://github.com/ansible/ansible) after 
Michael DeHaan committed
95 96
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.  
97

98
When filing a bug, please use the [issue template](https://raw2.github.com/ansible/ansible/devel/examples/issues/ISSUE_TEMPLATE.md) to provide all relevant information.
Michael DeHaan committed
99

Michael DeHaan committed
100 101 102 103 104 105 106 107 108 109 110
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.

To be respectful of reviewers time and allow us to help everyone efficiently, please 
provide minimal well-reduced and well-commented examples versus sharing your entire production
playbook.  Include playbook snippets and output where possible.  

Content in the GitHub bug tracker can be indented four spaces to preserve formatting.  
For multiple-file content, we encourage use of gist.github.com.  Online pastebin content can expire.

If you are not sure if something is a bug yet, you are welcome to ask about something on 
Michael DeHaan committed
111 112 113
the mailing list or IRC first.  As we are a very high volume project, if you determine that 
you do have a bug, please be sure to open the issue yourself to ensure we have a record of
it. Don’t rely on someone else in the community to file the bug report for you.
Michael DeHaan committed
114

Michael DeHaan committed
115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152
It may take some time to get to your report, see "A Note About Priorities" below.

A Note About Priorities
=======================

Ansible was one of the top 5 projects with the most OSS contributors on GitHub in 2013, and well over
600 people have added code to the project.  As a result, we have a LOT of incoming activity to process.

In the interest of transparency, we're telling you how we do this.

In our bug tracker you'll notice some labels - P1, P2, P3, P4, and P5.  These are our internal
priority orders that we use to sort tickets.  

With some exceptions for easy merges (like documentation typos for instance), 
we're going to spend most of our time working on P1 and P2 items first, including pull requests.  
These usually relate to important
bugs or features affecting large segments of the userbase.  So if you see something categorized
"P3 or P4", and it's not appearing to get a lot of immediate attention, this is why.

These labels don't really have definition - they are a simple ordering.  However something
affecting a major module (yum, apt, etc) is likely to be prioritized higher than a module
affecting a smaller number of users.

Since we place a strong emphasis on testing and code review, it may take a few months for a minor feature to get merged.

Don't worry though -- we'll also take periodic sweeps through the lower priority queues and give
them some attention as well, particularly in the area of new module changes.  So it doesn't neccessarily
mean that we'll be exhausting all of the higher-priority queues before getting to your ticket.

Release Numbering
=================

Releases ending in ".0" are major releases and this is where all new features land.  Releases ending
in another integer, like "0.X.1" and "0.X.2" are dot releases, and these are only going to contain
bugfixes.  Typically we don't do dot releases for minor releases, but may occasionally decide to cut
dot releases containing a large number of smaller fixes if it's still a fairly long time before
the next release comes out.

Michael DeHaan committed
153
Online Resources
Michael DeHaan committed
154
================
Michael DeHaan committed
155 156

Documentation
Michael DeHaan committed
157
-------------
Michael DeHaan committed
158

Michael DeHaan committed
159
The main ansible documentation can be found at [docs.ansible.com](http://docs.ansible.com). 
Michael DeHaan committed
160 161 162
As mentioned above this is an open source project, so we accept contributions to the documentation. 
You can also find some best practices examples that we recommend reading at 
[ansible-examples](http://github.com/ansible/ansible-examples).
Michael DeHaan committed
163 164

Mailing lists
Michael DeHaan committed
165
-------------
Michael DeHaan committed
166

Michael DeHaan committed
167 168
Ansible has several mailing lists.  Your first post to the mailing list will be 
moderated (to reduce spam), so please allow a day or less for your first post.
Michael DeHaan committed
169

Michael DeHaan committed
170 171 172
[ansible-announce](https://groups.google.com/forum/#!forum/ansible-announce) is for release 
announcements and major news.  It is a low traffic read-only list and you should only get a few 
emails a month.
Michael DeHaan committed
173

Michael DeHaan committed
174 175 176
[ansible-project](https://groups.google.com/forum/#!forum/ansible-project) is the main list, and is 
used for sharing cool projects you may have built, talking about Ansible ideas, and for users to ask 
questions or to help other users.
Michael DeHaan committed
177

Michael DeHaan committed
178 179 180
[ansible-devel](https://groups.google.com/forum/#!forum/ansible-devel) is a technical list for 
developers working on Ansible and Ansible modules.  Join here to discuss how to build modules, 
prospective feature implementations, or technical challenges.
Michael DeHaan committed
181

Michael DeHaan committed
182 183
To subscribe to a group from a non-google account, you can email the subscription address, for 
example ansible-devel+subscribe@googlegroups.com.
Michael DeHaan committed
184 185

IRC
Michael DeHaan committed
186
---
Michael DeHaan committed
187 188

Ansible has a general purpose IRC channel available at #ansible on irc.freenode.net.
Michael DeHaan committed
189 190
Use this channel for all types of conversations, including sharing tips, coordinating 
development work, or getting help from other users.
Michael DeHaan committed
191

Michael DeHaan committed
192 193 194
Miscellaneous Information
=========================

Michael DeHaan committed
195 196
Staff
-----
197

Michael DeHaan committed
198
Ansible, Inc is a company supporting Ansible and building additional solutions based on 
Michael DeHaan committed
199 200 201
Ansible.  We also do services and support for those that are interested.   Our most 
important task however is enabling all the great things that happen in the Ansible 
community, including organizing software releases of Ansible.  For more information about
Michael DeHaan committed
202
any of these things, contact info@ansible.com
203

Michael DeHaan committed
204
On IRC, you can find us as mdehaan, jimi_c, Tybstar, and others.   On the mailing list, 
Michael DeHaan committed
205
we post with an @ansible.com address.
206

Michael DeHaan committed
207
Community Code of Conduct
Michael DeHaan committed
208
-------------------------
209

Michael DeHaan committed
210 211 212 213
Ansible’s community welcomes users of all types, backgrounds, and skill levels. Please 
treat others as you expect to be treated, keep discussions positive, and avoid discrimination, profanity, allegations of Cthulhu worship, or engaging in controversial debates (except vi vs emacs is cool).  

Posts to mailing lists  should remain focused around Ansible and IT automation.   Abuse of these community guidelines will not be tolerated and may result in banning from community resources.
214

215
Contributors License Agreement
Michael DeHaan committed
216
------------------------------
217

Michael DeHaan committed
218 219 220 221
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, pursuant 
to the license of the project.
222 223 224