diff --git a/README.rst b/README.rst index 08bdfd4dc..18128b988 100644 --- a/README.rst +++ b/README.rst @@ -38,6 +38,24 @@ case in our issue management tool, JIRA: Bug reports in JIRA for all driver projects (i.e. PYTHON, CSHARP, JAVA) and the Core Server (i.e. SERVER) project are **public**. +How To Ask For Help +------------------- + +Please include all of the following information when opening an issue: + +- Detailed steps to reproduce the problem, including full traceback, if possible. +- The exact python version used, with patch level:: + + $ python -c "import sys; print(sys.version)" + +- The exact version of PyMongo used, with patch level:: + + $ python -c "import pymongo; print(pymongo.version); print(pymongo.has_c())" + +- The operating system and version (e.g. Windows 7, OSX 10.8, ...) +- Web framework or asynchonous network library used, if any, with version (e.g. + Django 1.7, mod_wsgi 4.3.0, gevent 1.0.1, Tornado 4.0.2, ...) + Security Vulnerabilities ------------------------