status-im/PyGithub
1
0
Fork 0
mirror of https://github.com/status-im/PyGithub.git synced 2026-08-31 19:01:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add a Contribute.md file (issue #94)

Browse Source 
See https://github.com/blog/1184-contributing-guidelines
This commit is contained in:
Vincent Jacques
2012-09-25 23:14:16 +02:00
parent df3290644a
commit a03066d2d5
1 changed files with 18 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Contributing.md
+18
View File
@@ -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`.