Skip to content

docs(governance): define the 0.x breaking-change notice procedure #43

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ucekmez wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(governance): define the 0.x breaking-change notice procedure #43

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions GOVERNANCE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,16 @@ EEP follows [Semantic Versioning](https://semver.org/) (semver):
- `1.x` — Stable. No breaking changes in patch releases. Minor versions add features but must remain additive. Breaking changes require a new major version.
- Platforms must advertise their supported EEP version in all responses via the `EEP-Version` header.

### 0.x breaking-change procedure

Because `0.x` permits breaking changes between minor versions, each such change MUST be announced with a **30-day notice** delivered through *all* of:

- a `### Breaking changes (pending)` entry in [`CHANGELOG.md`](./CHANGELOG.md) under **Unreleased**, naming the change and its target version;
- a pinned **GitHub Discussions** post in the *Announcements* category;
- the `EEP-Version` negotiation path ([SPECIFICATION.md §3.1.1](./docs/current/SPECIFICATION.md)): servers SHOULD advertise the upcoming version once the notice opens, and MAY emit a `Deprecation` / `Sunset` response header on affected endpoints.

The 30-day clock starts when the change merges to `main` behind its pending-version flag. This interim procedure applies until the formal 18-month deprecation policy takes effect at `v1.0`.
Comment on lines +61 to +63

## License

The EEP specification uses the Apache 2.0 license. Implementations are free to be open or proprietary.
Expand Down