<?xml version="1.0" encoding="utf-8" standalone="no"?>
<!DOCTYPE document PUBLIC "-//CNX//DTD CNXML 0.5 plus MathML//EN" "http://cnx.rice.edu/cnxml/0.5/DTD/cnxml_mathml.dtd">
<document xmlns="http://cnx.rice.edu/cnxml" xmlns:md="http://cnx.rice.edu/mdml/0.4" xmlns:m="http://www.w3.org/1998/Math/MathML" xmlns:bib="http://bibtexml.sf.net/" id="Module.2004-02-05.0114">
  <name>Reporting a Connexions Bug</name>
  <metadata>
  <md:version>1.7</md:version>
  <md:created>2004/02/05 13:01:14 US/Central</md:created>
  <md:revised>2008/01/04 15:59:25.844 US/Central</md:revised>
  <md:authorlist>
      <md:author id="mhusband">
      <md:firstname>Mark</md:firstname>
      <md:othername>S.</md:othername>
      <md:surname>Husband</md:surname>
      <md:email>mshusband@comcast.net</md:email>
    </md:author>
  </md:authorlist>

  <md:maintainerlist>
    <md:maintainer id="mhusband">
      <md:firstname>Mark</md:firstname>
      <md:othername>S.</md:othername>
      <md:surname>Husband</md:surname>
      <md:email>mshusband@comcast.net</md:email>
    </md:maintainer>
    <md:maintainer id="jago">
      <md:firstname>Adan</md:firstname>
      
      <md:surname>Galvan</md:surname>
      <md:email>agalvan@gmail.com</md:email>
    </md:maintainer>
  </md:maintainerlist>
  
  <md:keywordlist>
    <md:keyword>bug</md:keyword>
    <md:keyword>error</md:keyword>
    <md:keyword>task</md:keyword>
  </md:keywordlist>

  <md:abstract>Instructions for reporting bugs.</md:abstract>
</metadata>

  <content>
    <section id="bugintro">
    <name>Submitting a Bug Report</name> 

    <para id="bug1">In any software package you may encounter the occasional
    flaw with a feature or the documentation. Please bring these
    flaws, or <term>bugs</term>, to the attention of the Connexions team 
    with the <emphasis>Report a Bug</emphasis> link, which is located 
    on the <link src="http://cnx.org/">Connexions Home page</link> 
    and on other Connexions web pages in the Personal Toolbar.  
    </para>

    <para id="bug2">To report a bug, use the following steps:

      <list id="buglist" type="enumerated"><item>Click on the <emphasis>Report a Bug</emphasis> link. 
        The <link src="/bug_submit_form">Bug Report 
        Submission Form</link> displays.</item>
  <item>Enter a short summary of the problem.</item>
  <item>Enter your name and e-mail address. These aren't required, but it helps us to know who's having trouble, and if you don't enter an email address we can't get back to you with an answer.</item>
  <item>The page you were on immediately before the bug form is entered automatically into the "Problem URL" field. If you didn't come directly from the error page, please go back to the page where you had the problem and enter its address here. If the problem was on a module or collection, the object ID number is sufficient, e.g. m99999. A content object's ID appears in its URL or on the page behind the "More About This Content" link.</item>
  <item>Specify the nature of the error. Click the down arrow in
  the "Category" field and select the appropriate entry from the 
  drop-down menu.</item>
  <item>Specify the impact of the error. Click the down arrow in the 
  "Severity" field and select the appropriate entry from the drop-down 
  menu.</item>
  <item>Enter a one-line summary of the bug in the "Task Title" 
  field.</item>
  <item>Enter an explanation of the circumstances of the error in 
  the "Description" field. Include your actions and the system's 
  actions that led up to the error condition. If possible, include
  step-by-step instructions for reproducing the bug.</item>
  <item>Click <code>Submit</code> to enter the bug into 
        the Connexions tracking system.</item>
      </list>
</para>
    </section>

    <section id="bugtips">
     <name>Helpful Tips for Submitting Bug Reports</name> 

    <para id="para1">
      Here are some tips for submitting error reports that will help 
      us fix the bugs quickly. 

      <list id="list2"><item>First, do not close the <term>error message</term> display 
  until you have captured some information from it to include in your 
  bug report. The error message contains important information. If you 
  have left it to go to the 
  <link src="/bug_submit_form">Bug Report Submission 
  Form</link> or to a <link src="http://cnx.org/help/">Help</link> 
  page, use the Back function on your browser to redisplay the error 
  message.</item>

  <item>Include a copy of the error page. If the error displays an 
  actual error message, please copy the text of that message and paste 
  it into the bug report. It is even better to include the HTML source 
  of the error message -- some of our systems include important 
  information in HTML comments. While the error message is displaying, 
  right click your mouse and select the <code>View Source</code> or 
  <code>View Page Source</code> option, depending on your browser, to 
  display the HTML for the page. Then you can copy the HTML information 
  and paste it into the bug report.</item>

  <item>Full descriptions of errors are very useful. If your 
  error involved a specific module, include the name of the module. 
  If you were in the editing interface, include the workgroup and/or 
  module with which you were working. If you were using the Collection
  Composer, mention which course you were working with, and so forth. 
  Include the exact URL of the page on which the error occurred. 
  Always include a description of what you were doing, if you can.
  </item>
      </list>
      </para>
    </section>
  
  </content>
  
</document>
