diff --git a/src/docbkx/developer.xml b/src/docbkx/developer.xml
index 0c139b843ed..1335737a1bb 100644
--- a/src/docbkx/developer.xml
+++ b/src/docbkx/developer.xml
@@ -506,12 +506,29 @@ to fix the failing tests.
+
+
Code Standards
See and .
-
-
+ Also, please pay attention to the interface stability/audience classifications that you
+ will see all over our code base. They look like this at the head of the class:
+ @InterfaceAudience.Public
+@InterfaceStability.Stable
+
+ If the InterfaceAudience is Private,
+ we can change the class (and we do not need to include a InterfaceStability mark).
+ If a class is marked Public but its InterfaceStability
+ is marked Unstable, we can change it. If it's
+ marked Public/Evolving, we're allowed to change it
+ but should try not to. If it's Public and Stable
+ we can't change it without a deprecation path or with a really GREAT reason.
+ When you add new classes, mark them with the annotations above if publically accessible.
+ If you are not cleared on how to mark your additions, ask up on the dev list.
+
+ This convention comes from our parent project Hadoop.
+
@@ -539,6 +556,10 @@ to fix the failing tests.
Yes, please. Please try to include unit tests with every code patch (and especially new classes and large changes).
Make sure unit tests pass locally before submitting the patch.
Also, see .
+ If you are creating a new unit test class, notice how other unit test classes have classification/sizing
+ annotations at the top and a static method on the end. Be sure to include these in any new unit test files
+ you generate. See for more on how the annotations work.
+
Attach Patch to Jira
@@ -687,5 +708,6 @@ Bar bar = foo.getBar(); <--- imagine there's an extra space(s) after the
+