[
https://issues.apache.org/jira/browse/OAK-11871?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=18015123#comment-18015123
]
Konrad Windszus commented on OAK-11871:
---------------------------------------
I guess we should first make clearer what we consider public API. Is it only
https://jackrabbit.apache.org/oak/docs/apidocs/org/apache/jackrabbit/oak/api/package-summary.html
or something else as well. Some clarification on
https://jackrabbit.apache.org/oak/docs/oak_api/overview.html would be good.
> Expand oak/docs/participating vs API changes
> --------------------------------------------
>
> Key: OAK-11871
> URL: https://issues.apache.org/jira/browse/OAK-11871
> Project: Jackrabbit Oak
> Issue Type: Improvement
> Components: doc
> Reporter: Julian Reschke
> Assignee: Julian Reschke
> Priority: Minor
>
> I would like to expand Expand oak/docs/participating to discuss API changes a
> bit more:
> # Recommend that an API change gets at least one approval from committers
> familiar with package versioning.
> # Warn against minor version changes as well.
> # Mention the "@Internal" annotation.
> # Recommend not to extend public (non-internal) APIs unless it's clear that
> the new API will be needed outside Oak.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
