incubator-tinkerpop git commit: Add information about deprecation to CONTRIBUTING.

[sp...@apache.org]

Repository: incubator-tinkerpop
Updated Branches:
  refs/heads/tp30 266d70d45 -> b9ee1c03a


Add information about deprecation to CONTRIBUTING.


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

Branch: refs/heads/tp30
Commit: b9ee1c03a93babad66b01703dc35221a1aff5795
Parents: 266d70d
Author: Stephen Mallette <sp...@genoprime.com>
Authored: Wed Sep 9 09:24:57 2015 -0400
Committer: Stephen Mallette <sp...@genoprime.com>
Committed: Wed Sep 9 09:24:57 2015 -0400

----------------------------------------------------------------------
 CONTRIBUTING.asciidoc | 16 +++++++++++++++-
 1 file changed, 15 insertions(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/b9ee1c03/CONTRIBUTING.asciidoc
----------------------------------------------------------------------
diff --git a/CONTRIBUTING.asciidoc b/CONTRIBUTING.asciidoc
index 1e3f9a4..5956cca 100644
--- a/CONTRIBUTING.asciidoc
+++ b/CONTRIBUTING.asciidoc
@@ -148,4 +148,18 @@ Code Style
 
 Contributors should examine the current code base to determine what the code style patterns are and should match their
 style to what is already present.  Of specific note however, TinkerPop does not use "import wildcards" - IDEs should
-be adjusted accordingly to not auto-wildcard the imports.
\ No newline at end of file
+be adjusted accordingly to not auto-wildcard the imports.
+
+Deprecation
+~~~~~~~~~~~
+
+When possible, committers should avoid direct "breaking" change (e.g. removing a method from a class) and favor
+deprecation.  Deprecation should come with sufficient documentation and notice especially when the change involves
+public APIs that might be utilized by users or implemented by vendors:
+
+* Mark the code with the `@Deprecated` annotation.
+* Use javadoc to further document the change with the following pattern:
+`@deprecated As of release x.y.z, replaced by {@link #GremlinGroovyScriptEngine(CompilerCustomizerProvider...)}`.
+* All deprecation should be tied to a JIRA issue with a "breaking" label.
+* Provide a post to the developers and/or users mailing lists as the case requires to alert the community to the change.
+