Skip to content

Latest commit

 

History

History
50 lines (37 loc) · 1.97 KB

CONTRIBUTING.rst

File metadata and controls

50 lines (37 loc) · 1.97 KB

Guidelines for Contributing to github3.py

  1. Read the README

  2. Regardless of the magnitude your pull request (a couple lines to a couple hundred lines), please add your name to the AUTHORS.rst file under the heading Contributors.

  3. If you're fixing a bug, please write a regression test. All the tests are structured like so:

    tests/
- test_<module_name>.py
    + Test<ClassName>
      - def test_function_or_attribute

    Please do not add your regression test to an existing test, but create a new one. You can use the form test_issue_<number>. In a docstring add the link and a short description of the regression issue. For example, if you found a bug in the class Issue, write your test in the file test_issues.py in the class TestIssue. You can place the new test in any order, e.g., below all the existing tests, near a related one, &c.

  4. If you're adding a new section of the API that does not already exist, please also add tests to the test suite.

  5. If you're adding additional functionality beyond what the API covers, please open an issue reqeust first and of course add tests to cover the functionality in the event it is accepted.

    Also, please be certain to add docstrings to these functions. Follow the example of other docstrings.

  6. In case you haven't caught on, for anything you add, write tests.

  7. Be cordial.

  8. Rebase your fork/branch if needed and possible before submitting a pull request. This makes my life easier. If you honestly have no idea what I'm talking about, don't worry, I'll take care of it.

  9. Please follow pep-0008. Feel free to also use flake8 to help.