Skip to content
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.

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

add versioning and deprecation policy doc #3103

Merged
merged 1 commit into from
Sep 24, 2018
Merged
Changes from all commits
Commits
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
25 changes: 25 additions & 0 deletions PREBID_VERSIONING_DEPRECATION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Prebid versioning and deprecation policy

## Goals
Provide clear definitions and policy around versioning and breaking changes to APIs that are both publisher and demand partner facing.

- Limit the number of breaking changes.
- Ensure significant time for updates for breaking changes so that publisher or demand partners do not break.
- Provide a path to deprecation and reduce technical debt and increase security.
- Major versions should not be changed more than once per 30 days.

## Versioning

Follow semantic versioning so that all breaking changes occur within a major release. A breaking change includes both demand partner internal APIs* and publisher facing APIs (global APIs).

*Demand partner APIs may be excluded from breaking change policy at the core teams discretion if the changes are made so to be transparent to the bidders (such as internal refactoring).

## Deprecation process

- Open an issue with an "intent to implement" and "API impact" labels.
- Allow 2 weeks for discussion.
- Announce breaking change to the mailing list (TBD needs to be created).
- At least 2 core members needs to provide explicit approval for the deprecation.
- Open a PR against current master for console warning for possible breakage.
- Support the previous major version for a minimum of 30 days.
- Coordinate with the core team to ensure clean merging into feature branch if applicable (future major version branch).