[GitHub] [incubator-pinot] sunithabeeram opened a new issue #4031: Define annotations to inform InterfaceAudience and Stability

[GitBox <gi...@apache.org>]

sunithabeeram opened a new issue #4031: Define annotations to inform InterfaceAudience and Stability
URL: https://github.com/apache/incubator-pinot/issues/4031
 
 
   Many Apache open-source projects (Hadoop, Kafka) provide annotations for interfaces around the audience and stability. We should have similar annotations for Pinot to help with:
   a) Contributors trying to extend Pinot know which interfaces can be depended upon and how.
   b) Pinot committers can validate that code updates don't introduce backward incompatible changes.
   
   Proposal:
   Adopt annotations from: https://hadoop.apache.org/docs/r2.7.1/api/org/apache/hadoop/classification/InterfaceAudience.html and https://hadoop.apache.org/docs/r2.7.2/api/org/apache/hadoop/classification/InterfaceStability.html
   
   or similar. It might be better to stick to a widely known one such as the one from Hadoop to minimize confusion, but open to other suggestions.
   

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@pinot.apache.org
For additional commands, e-mail: commits-help@pinot.apache.org