|
1 | 1 | Contributing
|
2 | 2 | ============
|
3 | 3 |
|
4 |
| -If you’re reading this you’re probably interested in contributing to one of the |
5 |
| -Hyper projects! First, we'd like to say thankyou! Projects like this one |
| 4 | +If you’re reading this, you’re probably interested in contributing to one of the |
| 5 | +Hyper projects! First, we'd like to say thank you! Projects like this one |
6 | 6 | live-and-die based on the support they receive from others, and the fact that
|
7 | 7 | you’re even considering supporting the Hyper project is incredibly generous of
|
8 | 8 | you.
|
9 | 9 |
|
10 | 10 | This document lays out general guidelines and advice for contributing to any of
|
11 |
| -the Hyper projects. If you’re thinking of contributing, start by reading this |
12 |
| -thoroughly and getting a feel for how contributing to the project works. If |
| 11 | +the Hyper projects. If you’re thinking of helping, start by reading this |
| 12 | +thoroughly and getting a feel for how the project works. If |
13 | 13 | you’ve still got questions after reading this, please ask us in IRC: we'd be
|
14 | 14 | happy to clarify any questions you may have.
|
15 | 15 |
|
16 |
| -The guide is split into sections based on the type of contribution you’re |
17 |
| -thinking of making, with a section that covers general guidelines for all |
18 |
| -contributors. Additionally, there is a section to cover our code of conduct, |
19 |
| -which applies to all contributions of any kind. |
| 16 | +We've organized this guide into sections: |
| 17 | + |
| 18 | +- our code of conduct, which applies to all contributions of any kind |
| 19 | +- general guidelines for all contributors |
| 20 | +- specific information based on the type of contribution you’re |
| 21 | + thinking of making |
| 22 | + - code contributions |
| 23 | + - documentation |
| 24 | + - bug reports |
| 25 | + - feature requests |
20 | 26 |
|
21 | 27 | Code Of Conduct
|
22 | 28 | ---------------
|
@@ -118,9 +124,9 @@ into a contribution that is not suitable for the project.
|
118 | 124 | Contribution Suitablility
|
119 | 125 | ~~~~~~~~~~~~~~~~~~~~~~~~~
|
120 | 126 |
|
121 |
| -The maintainers of the specific sub-project have the last word on whether or |
122 |
| -not a contribution is suitable for that project. All contributions will be |
123 |
| -considered, but from time to time contributions will be rejected because they |
| 127 | +The maintainers of a sub-project have the last word on whether or |
| 128 | +not a contribution is suitable for that project. We consider all contributions, |
| 129 | +but from time to time contributions will be rejected because they |
124 | 130 | do not suit the project.
|
125 | 131 |
|
126 | 132 | If necessary, a contributor should feel free to ask maintainers of other hyper
|
@@ -167,22 +173,22 @@ report using the guidelines in the :ref:`bug-reports` section.
|
167 | 173 |
|
168 | 174 | If you've done this but want to get contributing right away, you can take
|
169 | 175 | advantage of the fact that all Hyper projects use a continuous integration
|
170 |
| -system. This will automatically run the tests against any pull request raised |
171 |
| -against any Hyper repository. The continuous integration system treats a |
172 |
| -regression in code coverage as a failure of the test suite. |
| 176 | +system. This system will automatically run the tests against any pull request |
| 177 | +raised against any Hyper repository. The continuous integration system treats |
| 178 | +a regression in code coverage as a failure of the test suite. |
173 | 179 |
|
174 |
| -Before a contribution is merged it must have a green run through the CI system. |
| 180 | +Before a contribution is merged, it must have a green run through the CI system. |
175 | 181 |
|
176 | 182 | .. _tox: http://tox.readthedocs.org/en/latest/
|
177 | 183 |
|
178 | 184 | Code Review
|
179 | 185 | ~~~~~~~~~~~
|
180 | 186 |
|
181 | 187 | Contributions will not be merged until they've been code reviewed. You should
|
182 |
| -implement any code review feedback unless you strongly object to it. In the |
183 |
| -event that you object to the code review feedback, you should make your case |
184 |
| -clearly and calmly. If, after doing so, the feedback is judged to still apply, |
185 |
| -you must either apply the feedback or withdraw your contribution. |
| 188 | +implement any code review feedback unless you strongly object to it. If |
| 189 | +you object to the code review feedback, you should make your case |
| 190 | +clearly and calmly. If, after doing so, the feedback is judged to apply still, |
| 191 | +you must either incorporate the feedback or withdraw your contribution. |
186 | 192 |
|
187 | 193 | New Contributors
|
188 | 194 | ~~~~~~~~~~~~~~~~
|
@@ -210,7 +216,7 @@ project, and the general documentation for the project as a whole live in the
|
210 | 216 | `Sphinx`_ to generate the full suite of documentation.
|
211 | 217 |
|
212 | 218 | When contributing documentation, please attempt to follow the style of the
|
213 |
| -documentation files. This means a soft-limit of 79 characters wide in your text |
| 219 | +documentation files. Use a soft-limit of 79 characters wide in your text |
214 | 220 | files and a semi-formal prose style.
|
215 | 221 |
|
216 | 222 |
|
|
0 commit comments