Skip to content

Commit fcdad6c

Browse files
committed
Added note about including version info in bug reports.
1 parent c30a5e7 commit fcdad6c

1 file changed

Lines changed: 5 additions & 0 deletions

File tree

doc/bugs.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,12 +41,17 @@ A good bug report will have the following:
4141

4242
* A descriptive title
4343
* A full Python traceback of the error, if there is one
44+
* The version of :mod:`github2` you are using [#]_
4445
* A minimal test-case to reproduce the error
4546
* A list of solutions you've already tried
4647

4748
Simon Tatham has an excellent essay titled `How to Report Bugs Effectively`_,
4849
with some excellent tips on filing good bug reports.
4950

51+
.. [#] The content of :data:`github2.__version__` if you're using an official
52+
release, or the output of :command:`git describe` if you're using the git
53+
repository directly.
54+
5055
.. _report an issue: https://github.com/ask/python-github2/issues/
5156
.. _API support forum: http://support.github.com/discussions/api
5257
.. _How to Report Bugs Effectively: http://www.chiark.greenend.org.uk/~sgtatham/bugs.html

0 commit comments

Comments
 (0)