1. ansible
  2. Commit 7495ad5a21f07ba64238d74f138f9f419cb4f330
Browse code

Update CONTRIBUTING.md

word wrap and formatting

Michael DeHaan authored on 2013/09/14 09:23:44
Showing 1 changed files
CONTRIBUTING.md
History View file @ 7495ad5
... ... 
@@ -1,55 +1,83 @@
1 1 
 Ansible Community  Information
2 2 
 ==============================
3 3
4 
-The purpose of the Ansible community is to  unite developers, system administrators, operations, and IT managers to share and build great automation solutions.
5 
-This document contains all sorts of information about how to contribute and interact with Ansible.  Welcome!
4 
+The purpose of the Ansible community is to  unite developers, system administrators, operations, and
5 
+IT managers to share and build great automation solutions.  This document contains all sorts of
6 
+information about how to contribute and interact with Ansible.  Welcome!
6 7
7 8 
 Ways to Interact
8 9 
 ================
9 10
10 
-There are a lot of ways to join and  be a part  of the  Ansible community.
11 
+There are a lot of ways to join and  be a part  of the  Ansible community, such as:
11 12
12 13 
 Sharing Ansible with Others
13 14 
 ---------------------------
14 15
15 
-You can help share Ansible with others by telling friends and colleagues ,  writing a lblog post, or presenting at user groups (like DevOps groups or the local LUG or BUG).  You are also 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.
16 
+You can help share Ansible with others by telling friends and colleagues, writing a blog post,
17 
+or presenting at user groups (like DevOps groups or the local LUG or BUG).  You are also
18 
+welcome to share slides on speakerdeck, sign up for a free account and tag it “Ansible”.
19 
+On Twitter, you can also share things with #ansible.
16 20
17 21 
 Sharing Tips and Tricks
18 22 
 -----------------------
19 23
20 
-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.
24 
+Join the [Ansible project mailing list](https://groups.google.com/forum/#!forum/ansible-project) and you
25 
+can share playbooks you may have written and other interesting implementation stories. Put your Ansible
26 
+content up on places like github  to share with others.
21 27
22 28 
 Sharing A Feature Idea
23 29 
 ----------------------
24 30
25 
-If you have an idea for a new feature, you can open a new ticket at [github.com/ansible/ansible](https://github.com/ansible/ansible), though in general we like to talk about feature ideas first and bring in lots of people into the discussion.   Consider stopping by Ansible project mailing list at (https://groups.google.com/forum/#!forum/ansible-project).
31 
+If you have an idea for a new feature, you can open a new ticket at
32 
+[github.com/ansible/ansible](https://github.com/ansible/ansible), though in general we like to
33 
+talk about feature ideas first and bring in lots of people into the discussion. Consider stopping
34 
+by the [Ansible project mailing list](https://groups.google.com/forum/#!forum/ansible-project) or #ansible
35 
+on irc.freenode.net.
26 36
27 37 
 Helping with Documentation
28 38 
 --------------------------
29 39
30 
-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 lives in the “docsite/latest/rst” subdirectory of the project.   Docs are in restructured text 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.
40 
+Ansible documentation is a community project too!  If you would like to help with the
41 
+documentation, whether correcting a typo or improving a section, or maybe even
42 
+documenting a new feature, submit a github pull request to  the code that
43 
+lives in the “docsite/latest/rst” subdirectory of the project.   Docs are in restructured text
44 
+format.  If you aren’t comfortable with restructured text, you can also open a ticket on
45 
+github about any errors you spot or sections you would like to see added. For more information
46 
+on creating pull requests, please refer to the
47 
+[github help guide](https://help.github.com/articles/using-pull-requests).
48 
+
31 49
32 50 
 Contributing Code
33 51 
 -----------------
34 52
35 
-The Ansible project keeps it’s source on github at [http://github.com/ansible/ansible](http://github.com/ansible/ansible)
36 
-and takes contributions through [github pull requests](https://help.github.com/articles/using-pull-requests).
53 
+The Ansible project keeps it’s source on github at
54 
+[github.com/ansible/ansible](http://github.com/ansible/ansible)
55 
+and takes contributions through
56 
+[github pull requests](https://help.github.com/articles/using-pull-requests).
37 57
38 58 
 When submitting patches, be sure to run the unit tests first “make tests” and always use
39 59 
 “git rebase” vs “git merge” (aliasing git pull to git pull --rebase is a great idea) to
40 60 
 avoid merge commits in your submissions.
41 61
42 
-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,
43 
-so it may take awhile to get your contributions in!  Patches should be made against the 'devel' branch.
62 
+We’ll then review your contributions and engage with you about questions and  so on.  Please be
63 
+advised we have a very large and active community, so it may take awhile to get your contributions
64 
+in!  Patches should be made against the 'devel' branch.
44 65
45 
-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 to the Module Developers documentation on our website at http://www.ansibleworks.com/docs/moduledev.html.
66 
+Contributions can be for new features like modules, or to fix bugs you or others have found. If you
67 
+are interested in writing new modules to be included in the core Ansible distribution, please refer
68 
+to the Module Developers documentation on our website at http://www.ansibleworks.com/docs/moduledev.html.
46 69
47 
-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.
70 
+Ansible's aesthetic encourages simple, readable code and consistent, conservatively extending,
71 
+backwards-compatible improvements.  Code developed for Ansible needs to support Python 2.6+,
72 
+while code in modules must run under Python 2.4 or higher.  Please also use a 4-space indent
73 
+and no tabs.
48 74
49 75 
 Reporting A Bug
50 76 
 ---------------
51 77
52 
-Bugs can be reported to [github.com/ansible/ansible](http://github.com/ansible/ansible) after 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.
78 
+Bugs can be reported to [github.com/ansible/ansible](http://github.com/ansible/ansible) after
79 
+signing up for a free github account.  Before reporting a bug, please use the bug/issue search
80 
+to see if the issue has already been reported.
53 81
54 82 
 When filing a bug, please make sure to include the following information in the bug report:
55 83
... ... 
@@ -58,7 +86,10 @@ When filing a bug, please make sure to include the following information in the
58 58 
 * Expected results
59 59 
 * Actual results.
60 60
61 
-If you are not sure if something is a bug yet, you are welcome to ask about something on 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.
61 
+If you are not sure if something is a bug yet, you are welcome to ask about something on
62 
+the mailing list or IRC first.  As we are a very high volume project, if you determine that
63 
+you do have a bug, please be sure to open the issue yourself to ensure we have a record of
64 
+it. Don’t rely on someone else in the community to file the bug report for you.
62 65
63 66 
 Online Resources
64 67 
 ================
... ... 
@@ -66,26 +97,38 @@ Online Resources
66 66 
 Documentation
67 67 
 -------------
68 68
69 
-The main ansible documentation can be found at [ansibleworks.com/docs](http://ansibleworks.com/docs).   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 http://github.com/ansible/ansible-examples.
69 
+The main ansible documentation can be found at [ansibleworks.com/docs](http://ansibleworks.com/docs).
70 
+As mentioned above this is an open source project, so we accept contributions to the documentation.
71 
+You can also find some best practices examples that we recommend reading at
72 
+[ansible-examples](http://github.com/ansible/ansible-examples).
70 73
71 74 
 Mailing lists
72 75 
 -------------
73 76
74 
-Ansible has several mailing lists.  The first post to the mailing list will be moderated (to reduce spam), so please allow a day or less for your first post.
77 
+Ansible has several mailing lists.  Your first post to the mailing list will be
78 
+moderated (to reduce spam), so please allow a day or less for your first post.
75 79
76 
-[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.
80 
+[ansible-announce](https://groups.google.com/forum/#!forum/ansible-announce) is for release
81 
+announcements and major news.  It is a low traffic read-only list and you should only get a few
82 
+emails a month.
77 83
78 
-[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.
84 
+[ansible-project](https://groups.google.com/forum/#!forum/ansible-project) is the main list, and is
85 
+used for sharing cool projects you may have built, talking about Ansible ideas, and for users to ask
86 
+questions or to help other users.
79 87
80 
-[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.
88 
+[ansible-devel](https://groups.google.com/forum/#!forum/ansible-devel) is a technical list for
89 
+developers working on Ansible and Ansible modules.  Join here to discuss how to build modules,
90 
+prospective feature implementations, or technical challenges.
81 91
82 
-To subscribe to a group from a non-google account, you can email the subscription address, for example ansible-devel+subscribe@googlegroups.com.
92 
+To subscribe to a group from a non-google account, you can email the subscription address, for
93 
+example ansible-devel+subscribe@googlegroups.com.
83 94
84 95 
 IRC
85 96 
 ---
86 97
87 98 
 Ansible has a general purpose IRC channel available at #ansible on irc.freenode.net.
88 
-Use this channel for all types of conversations, including sharing tips, coordinating development work, or getting help from other users.
99 
+Use this channel for all types of conversations, including sharing tips, coordinating
100 
+development work, or getting help from other users.
89 101
90 102 
 Miscellaneous Information
91 103 
 =========================
... ... 
@@ -93,20 +136,31 @@ Miscellaneous Information
93 93 
 AnsibleWorks Staff
94 94 
 ------------------
95 95
96 
-AnsibleWorks is a company supporting Ansible and building additional solutions based on 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 any of these things, contact info@ansibleworks.com
96 
+AnsibleWorks is a company supporting Ansible and building additional solutions based on
97 
+Ansible.  We also do services and support for those that are interested.   Our most
98 
+important task however is enabling all the great things that happen in the Ansible
99 
+community, including organizing software releases of Ansible.  For more information about
100 
+any of these things, contact info@ansibleworks.com
97 101
98 
-On IRC, you can find us as mdehaan, jimi_c, Tybstar, and others.   On the mailing list, we post with an @ansibleworks.com address.
102 
+On IRC, you can find us as mdehaan, jimi_c, Tybstar, and others.   On the mailing list,
103 
+we post with an @ansibleworks.com address.
99 104
100 105 
 Community Code of Conduct
101 106 
 -------------------------
102 107
103 
-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 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.
108 
+Ansible’s community welcomes users of all types, backgrounds, and skill levels.    Please
109 
+treat others as you expect to be treated, keep discussions positive, and avoid discrimination
110 
+or engaging in controversial debates (except vi vs emacs is cool).  Posts to mailing lists
111 
+should remain focused around Ansible and IT automation.   Abuse of these community guidelines
112 
+will not be tolerated and may result in banning from community resources.
104 113
105 114 
 Contributors License Agreement
106 115 
 ------------------------------
107 116
108 
-By contributing you agree that these contributions are your own (or approved by your employer) and you grant a full, complete, irrevocable
109 
-copyright license to all users and developers of the project, present and future, pursuant to the license of the project.
117 
+By contributing you agree that these contributions are your own (or approved by your employer)
118 
+and you grant a full, complete, irrevocable
119 
+copyright license to all users and developers of the project, present and future, pursuant
120 
+to the license of the project.
110 121
111 122
112 123