<?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.3</md:version>
  <md:created>2004/02/05 13:01:14 US/Central</md:created>
  <md:revised>2004/03/15 22:31:18.778 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>mhusband@rice.edu</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>mhusband@rice.edu</md:email>
    </md:maintainer>
    <md:maintainer id="jago">
      <md:firstname>Adan</md:firstname>
      
      <md:surname>Galvan</md:surname>
      <md:email>jago@rice.edu</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.rice.edu/">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="http://mountainbunker.org/bugReport">Bug Report 
        Submission Form</link> displays.</item>
	<item>Enter your name.</item>
	<item>Enter your e-mail address.</item>
	<item>Enter the module ID, if the error occurred while accessing 
	a module. This is a number, for example	m99999. If you do not know 
	the module number, view the module and display its "About" or 
	"History" pages. The module's ID is listed on those pages.</item>
	<item>Specify the nature of the error. Click the down arrow in
	the "Type" 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 Bug</code> to enter the bug into 
        the Connexions tracking system.</item>
      </list>
    
      <code>Reset</code> clears your entries on the form. 
	
    </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="http://mountainbunker.org/bugReport">Bug Report Submission 
	Form</link> or to a <link src="http://cnx.rice.edu/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>More information is always helpful. For a new system like 
	Connexions, 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 Course 
	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>
