accumulo-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Sean Busbey (JIRA)" <>
Subject [jira] [Commented] (ACCUMULO-2590) Update public API in readme to clarify what's included
Date Mon, 31 Mar 2014 21:55:18 GMT


Sean Busbey commented on ACCUMULO-2590:

How about if I quote the release governance document

API changes should only be made on major releases, with continued support of the previous
API for at least one major revision.

I'd link to it, but our current README format doesn't lend itself well to that.

> Update public API in readme to clarify what's included
> ------------------------------------------------------
>                 Key: ACCUMULO-2590
>                 URL:
>             Project: Accumulo
>          Issue Type: Task
>          Components: docs
>            Reporter: Sean Busbey
>            Assignee: Sean Busbey
>            Priority: Blocker
>             Fix For: 1.6.0
>         Attachments: ACCUMULO-2590.1.patch.txt
> Due to confusion expressed on the mailing list, edit the README section on the public
API to make unambiguous:
> # the list of packages included (e.g. "all packages under org.apache.accumulo.core.client,
save those named 'impl'")
> # that public Classes and Interfaces in those packages are covered
> # that within said Classes and Interfaces, we include
> ## public and protected members
> ## public and protected methods
> ## public and protected constructors
> ## public and protected inner Classes and Interfaces
> And that "compatibility" means binary compatibility as defined in the [Java Language
Spec v3, Chapter 13|]

This message was sent by Atlassian JIRA

View raw message