Author: crossley
Date: Fri Dec 23 21:57:25 2005
New Revision: 358918
URL: http://svn.apache.org/viewcvs?rev=358918&view=rev
Log:
Add Guidelines and explain special fields and permissions.
Add links to special search filters.
Modified:
forrest/trunk/site-author/content/xdocs/issues.xml
Modified: forrest/trunk/site-author/content/xdocs/issues.xml
URL:
http://svn.apache.org/viewcvs/forrest/trunk/site-author/content/xdocs/issues.xml?rev=358918&r1=358917&r2=358918&view=diff
==============================================================================
--- forrest/trunk/site-author/content/xdocs/issues.xml (original)
+++ forrest/trunk/site-author/content/xdocs/issues.xml Fri Dec 23 21:57:25 2005
@@ -16,28 +16,155 @@
limitations under the License.
-->
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN"
"http://forrest.apache.org/dtd/document-v20.dtd";>
-<document>
-<header>
- <title>Apache Forrest issue tracker</title>
-</header>
-<body>
+<document>
+<header>
+ <title>Apache Forrest issue tracker</title>
+</header>
+<body>
+
+ <section id="intro">
+ <title>Introduction</title>
<p>
- The Apache Forrest uses an issue tracker call Jira.
+ The Apache Forrest uses an issue tracker call Jira. All of the project
+ contributions should go there (not to the mailing list). This enables us to
+ keep track of contributions and to classify and manage the issues.
</p>
<p>
<a
href="http://issues.apache.org/jira/browse/FOR";>http://issues.apache.org/jira/browse/FOR</a>
+ is the main entry point which provides access to enter, view, search, and
+ add additional comments to issues. There are some additional search
+ <a href="#filters">filters</a> provided below.
</p>
<p>
You need to set up an account there before you can create new issues or
add comments to existing issues.
+ Anyone can register as a user and report issues.
+ See <a href="#guide">guidelines</a> below.
</p>
<p>
Note that the issue tracker is not a discussion or user help forum.
- Please discuss issues with using Forrest on the user or dev mailing list.
+ Please discuss issues about using Forrest on the user or dev mailing list.
</p>
+
+ </section>
+
+ <section id="guide">
+ <title>Guidelines and hints for reporting issues</title>
+ <ul>
+ <li>Follow the prompts below each entry field.</li>
+ <li>If you don't know the answer to a particular question, then
+ leave the field blank.</li>
+ <li>Add a concise initial Description, then add more Comments later to
+ further describe the issue.</li>
+ <li>Other people will follow up and enhance your description and
+ classifications.</li>
+ <li>If details about your computing environment are relevant
+ (e.g. Java version or operating system) then add them to a
Comment.</li>
+ </ul>
+
+ <section id="priority">
+ <title>Special fields: Priority (a.k.a. Severity)</title>
+ <p>
+ The Priority is the severity according to the issue reporter. This will
+ be a guideline to the development team to identify the most urgent
+ issues. It is not a guarantee that a Critical issue will be resolved
+ before a Major issue.
+ </p>
+ <p>
+ Follow the Jira help icon to see the definition of the options.
+ </p>
+ </section>
+
+ <section id="urgency">
+ <title>Special fields: Urgency</title>
+ <p>
+ The project team will classify this according to their urgency. The
aim is
+ to be able to see at a glance which issues should be attended to, so
that
+ developers can operate efficiently and so that the product can be
released
+ as soon as possible. Some issues hinder the project, so need to be
identified.
+ </p>
+
+ <p>
+ We use the following definition of the options.
+ </p>
+
+ <ul>
+ <li>
+ None: The default. Not yet classified.
+ </li>
+ <li>
+ Blocker: Prevents other developers from working; or critical issue
with functionality;
+ or holds up the implementation of other functionality.
+ Cannot release until it is fixed. Will be fixed ASAP.
+ </li>
+ <li>
+ Urgent: Is a key new feature; or affects many users. Will be fixed
before the next
+ release.
+ </li>
+ <li>
+ Normal: If this issue scratches the itch of any particular
developer, then
+ they should help to solve it and provide a patch.
+ </li>
+ <li>
+ Low: If this issue bothers you, then fix it because it is not a high
priority
+ for the project.
+ </li>
+ </ul>
+ </section>
+
+ <section id="permissions">
+ <title>Permissions</title>
+ <ul>
+ <li>
+ Anyone: Browse, Find, View.
+ </li>
+ <li>
+ jira-users: People who have registered as a user of the ASF Jira.
+ Create, Edit, Comment, Attach, Vote, Watch.
+ The reporter can also Close.
+ </li>
+ <li>
+ forrest-developers: People who are Forrest committers.
+ Resolve, Close, Delete issues, Delete coments, Link, Assign,
Administer Projects.
+ </li>
+ <li>
+ Some committers are global adminstrators: Edit user details, Add
users to groups, Configure.
+ </li>
+ </ul>
+ </section>
+ </section>
+
+ <section id="filters">
+ <title>Some search filters</title>
+ <p>
+ Various general searches are available from the
+ <a href="http://issues.apache.org/jira/browse/FOR";>front page</a>,
+ e.g. "open issues classified by component", or "Added recently".
+ The following are some special filters.
+ </p>
+
+ <ul>
+ <li>
+ <a
href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?mode=hide&requestId=12310472";>FOR-open-with-patch</a>
+ - Committers need to visit this regularly and deal with the patches.
+ </li>
+ <li>
+ <a
href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?mode=hide&requestId=12310473";>FOR-urgency-blocker</a>
+ - Issues that the project considers to be Blockers.
+ </li>
+ <li>
+ <a
href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?mode=hide&requestId=12310475";>FOR-urgency-urgent</a>
+ - Issues that the project considers to be Urgent.
+ </li>
+ <li>
+ <a
href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?mode=hide&requestId=12310043";>FOR-unscheduled</a>
+ - Issues that have not yet been scheduled to be fixed for a certain
version.
+ </li>
+ </ul>
+ </section>
</body>
</document>
