From ea8fe63abd8662d44e7a0810b2df1bc44f98c963 Mon Sep 17 00:00:00 2001
From: Jamie Kimberley <jamie.kimberley@gmail.com>
Date: Sun, 3 Jan 2010 12:06:50 -0500
Subject: [PATCH] Add documentation for our issue tracker

Added instructions and links for submitting bug reports and feature
requests to the website documentation.
---
 doc/Makefile                 |  3 +++
 doc/developers-guide.content |  8 ++++++--
 doc/genpage.pl               |  1 +
 doc/report-a-bug.content     | 19 +++++++++++++++++++
 doc/wishlist.content         |  6 ++++++
 5 files changed, 35 insertions(+), 2 deletions(-)
 create mode 100644 doc/report-a-bug.content

diff --git a/doc/Makefile b/doc/Makefile
index 6b63d0db6..9b15e3da0 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -46,6 +46,9 @@ license.html: license.content genpage.pl
 mailing-list.html: mailing-list.content genpage.pl
 	./genpage.pl "Mailing Lists" $< > $@
 
+report-a-bug.html: report-a-bug.content genpage.pl
+	./genpage.pl "Report a Bug" $< > $@
+
 screenshots.html: screenshots.content genpage.pl
 	./genpage.pl "Screenshots" $< > $@
 
diff --git a/doc/developers-guide.content b/doc/developers-guide.content
index 637d24280..aafa5a219 100644
--- a/doc/developers-guide.content
+++ b/doc/developers-guide.content
@@ -208,8 +208,12 @@ to take the time to write good commit messages, as they form a history of who
 has changed which lines of code and for what purpose.  The first line of every
 commit message should be a short description of 50 characters or less.  The
 second line should be blank.  Subsequent lines should be less than 80
-characters long and should describe the change in detail.  Once I write the
-file and exit the editor, <em>git-log</em> will show the result:</p>
+characters long and should describe the change in detail. If your commit
+addresses an existing bug or feature please add a tag to the body of your
+commit message. Allowable tags are "fixes" which is used to close an
+issue and "refs" to reference an issue. For example, adding the text
+"fixes #2" will close issue #2.  Once I write the file and exit the
+editor, <em>git-log</em> will show the result:</p>
 
 <blockquote>
 <pre>
diff --git a/doc/genpage.pl b/doc/genpage.pl
index 66bd7f752..3cc313ea2 100755
--- a/doc/genpage.pl
+++ b/doc/genpage.pl
@@ -64,6 +64,7 @@ body {
 <br> <b><a href="contrib.html">Contributors</a></b>
 <br> <b><a href="search.html">Search</a></b>
 <br> <b><a href="mailing-list.html">Mailing List</a></b>
+<br> <b><a href="report-a-bug.html">Report a Bug</a></b>
 
 </center>
 </td>
diff --git a/doc/report-a-bug.content b/doc/report-a-bug.content
new file mode 100644
index 000000000..9a92ab528
--- /dev/null
+++ b/doc/report-a-bug.content
@@ -0,0 +1,19 @@
+<p> If you think that you have found a bug in GoldenCheetah or would like
+to request a new feature please report it by filing a new issue at our <a
+href=http://bugs.goldencheetah.org/projects/show/goldencheetah>issue
+tracker</a>. To report a bug/feature request go to the above link and
+follow these steps:
+
+<ol>
+<li>Login or register for a new account.</li>
+<li>Click the "new issue" link near the top of the page.</li>
+<li>Select either "bug" or "feature" from the tracker drop-down menu.</li>
+<li>Fill out the form including as much detail as possible.<br>
+    You can upload crashreports, problem files, or screenshots if they
+    help document the issue.</li>
+<li>Click the create button to save your report.<br>
+    This will also  send a copy of your report to the Golden-Cheetah-Users
+    mailing list.</li>
+</ol>
+<p>
+Thanks for helping to improve GoldenCheetah.
diff --git a/doc/wishlist.content b/doc/wishlist.content
index e3d5b7ae8..7d23f59aa 100644
--- a/doc/wishlist.content
+++ b/doc/wishlist.content
@@ -1,6 +1,12 @@
 <big><font face="arial,helvetica,sanserif">
 I wish GoldenCheetah would let me...
 </font></big>
+<p>If you have a new feature that you'd like to see in GoldenCheetah
+please create a new issue on our
+<a href=http://bugs.goldencheetah.org/projects/show/goldencheetah>bug/feature
+tracker</a>. Instructions for doing so are <a href="report-a-bug.html">here</a>.
+<p>
+Examples of some features are:
 <ul>
 <li>Graph ride metrics (daily hours, work, BikeScore) over the long
     term (weeks, seasons)</li>