@@ -5,53 +5,53 @@ Guidelines for Contributing to github3.py
55
66#. Please do **not ** use the issue tracker for questions.
77
8- #. Please use GitHub's search feature to look for already reported issues
8+ #. Please use GitHub's search feature to look for already reported issues
99 before reporting your own.
1010
11- #. Regardless of the magnitude your pull request (a couple lines to a couple
12- hundred lines), please add your name to theAUTHORS.rst _ file under the
11+ #. Regardless of the magnitude your pull request (a couple lines to a couple
12+ hundred lines), please add your name to theAUTHORS.rst _ file under the
1313 heading Contributors.
1414
1515#. There is a label for issues that should be minor and should be a good way
16- to become acquainted with the project. Theeasy _ label is the over-arching
17- way to determine which issues you can dig into without a great deal of
18- prior knowledge. Most of these issues have a `Pair with Ian `_ label which
19- means that if you would like, I (@sigmavirus24) will happily pair program
16+ to become acquainted with the project. Theeasy _ label is the over-arching
17+ way to determine which issues you can dig into without a great deal of
18+ prior knowledge. Most of these issues have a `Pair with Ian `_ label which
19+ means that if you would like, I (@sigmavirus24) will happily pair program
2020 with you to solve the issue.
2121
22- #. If you're fixing a bug, please write a regression test. All the tests are
22+ #. If you're fixing a bug, please write a regression test. All the tests are
2323 structured like so::
2424
2525 tests/
2626 - test_<module_name>.py
2727 + Test<ClassName>
2828 - def test_function_or_attribute
2929
30- Please do not add your regression test to an existing test, but create a
31- new one. You can use the form ``test_issue_<number> ``. In a docstring add
32- the link and a short description of the regression issue. For example, if
33- you found a bug in the class ``Issue ``, write your test in the file
34- ``test_issues.py `` in the class ``TestIssue ``. You can place the new test
30+ Please do not add your regression test to an existing test, but create a
31+ new one. You can use the form ``test_issue_<number> ``. In a docstring add
32+ the link and a short description of the regression issue. For example, if
33+ you found a bug in the class ``Issue ``, write your test in the file
34+ ``test_issues.py `` in the class ``TestIssue ``. You can place the new test
3535 in any order, e.g., below all the existing tests, near a related one, &c.
3636
37- #. If you're adding a new section of the API that does not already exist,
37+ #. If you're adding a new section of the API that does not already exist,
3838 please also add tests to the test suite.
3939
40- #. If you're adding additional functionality beyond what the API covers,
41- please open an issue request first and of course add tests to cover the
40+ #. If you're adding additional functionality beyond what the API covers,
41+ please open an issue request first and of course add tests to cover the
4242 functionality in the event it is accepted.
4343
44- Also, please be certain to adddocstrings _ to these functions. Follow the
44+ Also, please be certain to adddocstrings _ to these functions. Follow the
4545 example of other docstrings.
4646
4747#. In case you haven't caught on, for anything you add, write tests.
4848
49- #. Becordial _. Seriously, anyone who isn't cordial will be sent packing,
50- regardless of the value of their contributions. I will not tolerate some
49+ #. Becordial _. Seriously, anyone who isn't cordial will be sent packing,
50+ regardless of the value of their contributions. I will not tolerate some
5151 contributors creating a hostile environment for others.
5252
53- #. Rebase your fork/branch if needed and possible before submitting a pull
54- request. This makes my life easier. If you honestly have no idea what I'm
53+ #. Rebase your fork/branch if needed and possible before submitting a pull
54+ request. This makes my life easier. If you honestly have no idea what I'm
5555 talking about, don't worry, I'll take care of it.
5656
5757#. Please followpep-0008 _. Feel free to also useflake8 _ to help.