Skip to content

Commit

Permalink
Add a Contribute.md file (issue #94)
Browse files Browse the repository at this point in the history
  • Loading branch information
jacquev6 committed Sep 25, 2012
1 parent df32906 commit a03066d
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions Contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
Issues
======

A good issue includes a [short, self contained, correct example](http://sscce.org/) of the problem, something like:

assert github.Github().get_user("jacquev6").name == "Vincent Jacques"

It is even better if you provide the debug logs associated with your issue.
Enable them with `github.enable_console_debug_logging()` and copy them in the body of the issue.
Warning, you may want to remove some private information (authentication information is removed, but there may be private stuff in the messages)

If for any reason you are not able to provide, open your issue anyway and we will see what is needed to solve your problem.

Pull requests
=============

PyGithub follows [pep8 Style Guide for Python Code](http://www.python.org/dev/peps/pep-0008/) except for line length.
So if you do heavy modifications, please check your code with [pep8 Python style guide checker](http://pypi.python.org/pypi/pep8), by running `pep8 --ignore=E501 github`.

0 comments on commit a03066d

Please sign in to comment.