You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tinkerpop.apache.org by sp...@apache.org on 2015/03/24 13:37:33 UTC

incubator-tinkerpop git commit: Update README on Issue Conventions.

Repository: incubator-tinkerpop
Updated Branches:
  refs/heads/master 63868ab3f -> 922002848


Update README on Issue Conventions.


Project: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/commit/92200284
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/tree/92200284
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/diff/92200284

Branch: refs/heads/master
Commit: 922002848c895a5e7d0c2cbcb62675a575f1327c
Parents: 63868ab
Author: Stephen Mallette <sp...@apache.org>
Authored: Tue Mar 24 08:37:20 2015 -0400
Committer: Stephen Mallette <sp...@apache.org>
Committed: Tue Mar 24 08:37:20 2015 -0400

----------------------------------------------------------------------
 README.asciidoc | 1 +
 1 file changed, 1 insertion(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/92200284/README.asciidoc
----------------------------------------------------------------------
diff --git a/README.asciidoc b/README.asciidoc
index 0ed4b68..659eae7 100644
--- a/README.asciidoc
+++ b/README.asciidoc
@@ -86,6 +86,7 @@ TinkerPop3 uses Apache JIRA as its link:https://issues.apache.org/jira/browse/TI
 * An issue's "status" should be in one of two states: `open` or `closed`.
 ** An `open` issue is newly created, under consideration or otherwise in progress.
 ** A `closed` issue is completed for purposes of release (i.e. code, testing, and documentation complete).
+* When marking an issue as `closed`, its "resolution" field should always be set to `done`.  This single resolution simply means that the issue is complete, purposely does not convey the manner in which it was completed.  Consult the comments for information on the circumstances representing how the issue was resolved.
 * An issue's "type" should be one of two options: `bug` or `improvement`.  A `bug` has a very specific meaning, referring to an error that prevents usage of TinkerPop AND does not have a reasonable workaround.  Given that definition, a `bug` should generally have very high priority for a fix.  Everything else is an `improvement` in the sense that any other work is an enhancement to the current codebase.
 * The "component" should be representative of the primary area of code that it applies to and all issues should have this property set.
 * The "priority" of an issue is represented by two states `critical` and `major`.  It should be assigned as follows: