[Checkins] SVN: developer_docs/trunk/source/ Add a skeleton page on reporting bugs.
Tres Seaver
tseaver at palladion.com
Wed Apr 21 17:33:56 EDT 2010
Log message for revision 111245:
Add a skeleton page on reporting bugs.
Changed:
U developer_docs/trunk/source/index.rst
A developer_docs/trunk/source/reporting-bugs.rst
-=-
Modified: developer_docs/trunk/source/index.rst
===================================================================
--- developer_docs/trunk/source/index.rst 2010-04-21 21:33:55 UTC (rev 111244)
+++ developer_docs/trunk/source/index.rst 2010-04-21 21:33:55 UTC (rev 111245)
@@ -38,6 +38,7 @@
.. toctree::
:maxdepth: 2
+ reporting-bugs
noncommitter-svn
noncommitter-bzr
Added: developer_docs/trunk/source/reporting-bugs.rst
===================================================================
--- developer_docs/trunk/source/reporting-bugs.rst (rev 0)
+++ developer_docs/trunk/source/reporting-bugs.rst 2010-04-21 21:33:55 UTC (rev 111245)
@@ -0,0 +1,36 @@
+Reporting Bugs against Zope Packages
+====================================
+
+.. note::
+
+ This outline needs fleshing out.
+
+
+Identifying the Project which Has the Bug
+-----------------------------------------
+
+- Look at tracebacks from "bottom up".
+
+- Look for recently updated eggs.
+
+
+Writing the Bug Report
+----------------------
+
+- Identify version(s) of code which manifest the bug
+
+- Describe the symptom as clearly as possible.
+
+- Provide a complete recipe for reproducing the bug.
+
+
+Useful Patches for the Bug Report
+---------------------------------
+
+In order of increasing helpfulness:
+
+- Changes to non-test code which work around the problem
+
+- Unit tests which fail against the current code
+
+- Changes to non-test code, which pass against those tests.
More information about the checkins
mailing list