You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@rave.apache.org by bu...@apache.org on 2011/08/26 19:40:11 UTC

svn commit: r794936 - /websites/staging/rave/trunk/content/rave/issue-management.html

Author: buildbot
Date: Fri Aug 26 17:40:11 2011
New Revision: 794936

Log:
Staging update by buildbot

Added:
    websites/staging/rave/trunk/content/rave/issue-management.html

Added: websites/staging/rave/trunk/content/rave/issue-management.html
==============================================================================
--- websites/staging/rave/trunk/content/rave/issue-management.html (added)
+++ websites/staging/rave/trunk/content/rave/issue-management.html Fri Aug 26 17:40:11 2011
@@ -0,0 +1,131 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<!--
+
+    Licensed to the Apache Software Foundation (ASF) under one or more
+    contributor license agreements.  See the NOTICE file distributed with
+    this work for additional information regarding copyright ownership.
+    The ASF licenses this file to You under the Apache License, Version 2.0
+    (the "License"); you may not use this file except in compliance with
+    the License.  You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE- 2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+-->
+  <link rel="shortcut icon" href="/rave/images/RAVE-icon.ico" type="image/x-icon" />
+  <link href="/rave/css/rave.css" rel="stylesheet" type="text/css">
+  <title>Issue Management</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+</head>
+
+<body>
+  <div id="banner">
+    <img id="logo" alt="Apache Rave (Incubating)" src="/rave/images/RAVE-logo_main-logo-small.png"/>
+  </div>
+  
+  <div id="navigation">
+  <h1 id="general">General</h1>
+<ul>
+<li><a href="/rave/index.html">About</a></li>
+<li><a href="/rave/documentation/index.html">Documentation</a></li>
+<li><a href="/rave/downloads.html">Downloads</a></li>
+<li><a href="http://incubator.apache.org/projects/rave.html">Incubator page</a></li>
+<li><a href="/rave/license.html">License</a></li>
+</ul>
+<h1 id="community">Community</h1>
+<ul>
+<li><a href="/rave/get-involved.html">Get Involved</a></li>
+<li><a href="/rave/mailing-lists.html">Mailing Lists</a></li>
+<li><a href="/rave/people.html">People</a></li>
+</ul>
+<h1 id="development">Development</h1>
+<ul>
+<li><a href="/rave/source.html">Getting Started</a></li>
+<li><a href="/rave/ide-settings-and-debugging.html">IDE Settings and debugging</a></li>
+<li><a href="/rave/release-management.html">Release Management</a></li>
+<li><a href="https://issues.apache.org/jira/browse/rave">Issue Tracker</a></li>
+<li><a href="https://builds.apache.org/hudson/view/M-R/view/Rave/">Continuous Integration</a></li>
+<li><a href="https://analysis.apache.org/dashboard/index/58996">Sonar Dashboard</a></li>
+<li><a href="/rave/edit-website.html">Website</a></li>
+</ul>
+<h1 id="asf">ASF</h1>
+<ul>
+<li><a href="http://www.apache.org">Apache Software Foundation</a></li>
+<li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
+<li><a href="http://www.apache.org/foundation/sponsorship.html">Become a Sponsor</a></li>
+<li><a href="http://www.apache.org/security/">Security</a></li>
+</ul>
+    <a alt="Apache Incubator" href="http://incubator.apache.org">
+      <img id="asf-logo" alt="Apache Incubator" src="/rave/images/apache-incubator-logo.png"/>
+    </a>
+  </div>
+
+  <div id="content">
+    <h1 class="title">Issue Management</h1>
+    <p>All issues are tracked and managed in the Apache JIRA instance (<a href="https://issues.apache.org/jira/browse/rave">https://issues.apache.org/jira/browse/rave</a>).  Please follow the guidelines below when creating issues for Rave in JIRA.</p>
+<h4 id="issue_management_guidelines">Issue Management Guidelines</h4>
+<ul>
+<li>
+<p>Use the proper issue type</p>
+<p>The Apache JIRA instance defines many types of issues.  To keep issue management as simple as possible, the Rave community uses a small subset of the available types.  When creating a new issue, please select from the following list the type of issue that best describes the scope and size of the issue:</p>
+<ul>
+<li>
+<p><em>Epic</em></p>
+<p>An Epic represents a large set of features that support the same end goal.  For instance, building a new widget provider would best be represented by an Epic as there are multiple features that must be developed in order to reach the goal.</p>
+</li>
+<li>
+<p><em>Story</em> </p>
+<p>A story represents a single feature that may or may not support an epic.  As a rule of thumb, a single developer should be able to complete a story within 1-2 weeks.<br />
+</p>
+</li>
+<li>
+<p><em>Sub-task</em></p>
+<p>Sub-tasks represent the implementation details for a specific story.  These are the development, documentation and testing tasks that must be completed for the feature represented by the story to be functional.</p>
+</li>
+<li>
+<p><em>Bug</em></p>
+<p>A bug represents any defect with the software that causes it to behave in unexpected or incorrect ways.</p>
+</li>
+</ul>
+</li>
+<li>
+<p>Create links between issues</p>
+<p>Linking issues is important to provide traceability and overall reduction in management complexity for the issue tracker.  Links connect two different issues with a meaningful relationship.  You may use any of the available links when connecting two issues together. </p>
+<p>NOTE:  There is no explicity Epic/Story relationship built into JIRA.  If you are creating a story that supports an epic you must relate it via the "is part of" link.<br />
+</p>
+</li>
+<li>
+<p>Look for similar issues before creating a new one</p>
+<p>Often, there is an existing issue that is similar to the one that you are creating.  Before creating a new issue, look for a similar one and either update it to reflect additional usages/error conditions.<br />
+</p>
+</li>
+<li>
+<p>Assign the correct component</p>
+<p>As Rave becomes more complex, a correctly assigned component will assist the team in identifying and resolving issues.</p>
+</li>
+<li>
+<p>Assign tasks</p>
+<p>If you are going to be working on an issue, first assign it to yourself so that no one else in the community begins working on it at the same time.</p>
+</li>
+</ul>
+  </div>
+
+  <div id="footer">
+    <div class="copyright">
+      <p>
+        Copyright &copy; 2011 The Apache Software Foundation, Licensed under
+        the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
+        <br />
+        Apache and the Apache feather logos are trademarks of The Apache Software Foundation.
+      </p>
+    </div>
+  </div>
+
+</body>
+</html>