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.

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

Jump to bottom

Create breaking-changes.md #35403

Closed
wants to merge 4 commits into from
Closed

Create breaking-changes.md #35403

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
304d1b9
Create breaking-changes.md
mit-mit Dec 13, 2018
e4cfb2d
Update breaking-changes.md
mit-mit Jan 9, 2019
465ace6
Review feedback
mit-mit Jan 16, 2019
ee8f463
Review feedback from Kathy
mit-mit Jan 17, 2019
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
11 changes: 6 additions & 5 deletions docs/process/breaking-changes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,15 @@ It is not practical to offer compatability to programs that do not follow
best practices. Thus, the breaking change process assumes that programs
abide by the following basic conditions:

* Must contain no static analysis **errors**
* Must contain no static analysis **errors**.

* Must not catch a runtime **error**
* Must not rely on certain runtime **error** being thrown (in other words,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

certain -> a certain
(or error -> errors)

a new SDK might throw fewer errors than an old SDK).

* Must access libraries via the public API (for example, must not reach into the
internals of a package).
* Must access libraries via the public API (for example, must not reach into
the internals of a package located in the `/src/` directory).

* Must not rely on an [experiment flag](flags.md)
* Must not rely on an [experiment flag](flags.md).

* Must not circumvent clear restrictions documented in the public API
documentation (for example, must not mixin a class clearly documented as
Expand Down