Reporting a bug / requesting an enhancement

Should note in passing that these can go through the mailing list or
Launchpad...

Signed-off-by: Dan Scott <dscott@laurentian.ca>

diff --git a/eg2012_ddd.txt b/eg2012_ddd.txt
index 12ed996..8af1cd2 100644 (file)
--- a/eg2012_ddd.txt
+++ b/eg2012_ddd.txt
@@ -137,8 +137,6 @@ Anatomy of a git commit message
     the changeset and believes that it is ready to be part of the core
     repository
 
-
-
 What do developers do?
 ----------------------
   * Create Evergreen releases
@@ -214,11 +212,45 @@ Bug workflow
     `Fix committed`
   . When the code is released in an official release, the bug is marked
     `Fix released`
+
+Reporting a bug
+---------------
+Developers are a lazy species with short attention spans. To increase the
+chances that your problem will be understood and worked on by a developer:
+
+  * Describe the problem with a succinct but clear one-liner
+  * Provide a more detailed description of the bug:
+    ** What did you do (step by step)?
+    ** What happened?
+    ** What did you expect to happen?
+  * Include a description of your environment (OpenSRF version, Evergreen
+    version, PostgreSQL version, operating system, configuration settings,
+    browser (if applicable))
+  * A screenshot may be helpful in illustrating the problem, but recognize
+    that many developers live inside terminals
+
+Describing an enhancement
+-------------------------
+Similar to reporting a bug, describing an enhancement ideally can be
+summarized by a meaningful one-liner but also includes a more detailed
+description.
+
+Include different scenarios for the desired functionality; some aspects
+to consider:
+
+  * Does the catalog vs. staff client context matter?
+  * Should this new functionality be part the default behavior, or
+    should it be something sites have to enable?
+  * What configuration settings are required, and where should they be set?
+      ** User preferences
+      ** Library settings
+      ** opensrf.xml values
+      ** Catalog / staff client customization
  
 Communicate - Google Hangout
 ----------------------------
   * Newest form of group communication
-  * Attempted during Hackfest 2012
+  * Attempted during Hackfest 2012 with underwhelming results
   * *Extremely* hard to search (impossible?)
 
 Developer Glossary
@@ -226,5 +258,4 @@ Developer Glossary
   * _Tuits_, or _Round tuits_ - a fictional device that would enable the
     holder to accomplish all tasks that simply require time; as in "When I get
     around to it"
-  * _Reproducible test case_