Skip to content

Commit b1b6a4c

Browse files
author
Jimmy Jia
committed
[changed] Add two-release deprecation policy
Fixes react-bootstrap#863
1 parent 2a0b073 commit b1b6a4c

File tree

3 files changed

+18
-8
lines changed

3 files changed

+18
-8
lines changed

CONTRIBUTING.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,16 @@ Also Bootstrap mentions http://getbootstrap.com/getting-started/#examples
8282
as examples of things you can do, but they are not part of the core library,
8383
therefore this project is the wrong place to implement them.
8484

85+
## Breaking changes
86+
87+
Breaking changes should be accompanied with deprecations of removed
88+
functionality. Prior to the 1.0.0 release, we aim to follow React's example of
89+
taking two Minor releases to break old functionality. As such, changes that
90+
intend to remove or change public APIs should be be submitted against the
91+
`vX-rc` branch, and should be accompanied with deprecation warnings on the old
92+
APIs. The deprecated APIs themselves should not be removed until the Minor
93+
release after that.
94+
8595

8696
## Collaborators
8797

MAINTAINING.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -95,13 +95,13 @@ then be re-applied and released with the proper version bump.
9595
### Release Candidates
9696

9797
In an effort to reduce the frequency with which we introduce breaking changes we
98-
should do our best to first push deprecation warnings in a Minor or Patch
99-
release. Also, Pull Requests with breaking changes should be submitted against
100-
the `vX-rc` branch, where X is the next Major version. Which we will in turn
101-
release as an `alpha` release of the next Major version. When we are ready to
102-
release the next Major version bump we will merge the `vX-rc` branch into the
103-
`master` branch and cut a `beta` release. Once bugs have been addressed with
104-
the `beta` release then we will release the Major version bump.
98+
should do our best to first push deprecation warnings in a Minor release. Also,
99+
Pull Requests with breaking changes should be submitted against the `vX-rc`
100+
branch, where X is the next Major version. Which we will in turn release as an
101+
`alpha` release of the next Major version. When we are ready to release the next
102+
Major version bump we will merge the `vX-rc` branch into the `master` branch and
103+
cut a `beta` release. Once bugs have been addressed with the `beta` release
104+
then we will release the Major version bump.
105105

106106
### Live releasing the documentation
107107

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
[![devDependency Status][dev-deps-badge]][dev-deps]
1616
[![peerDependency Status][peer-deps-badge]][peer-deps]
1717

18-
__Under active development - APIs will change.__ Check out the [1.0.0 Roadmap](https://github.com/react-bootstrap/react-bootstrap/wiki#100-roadmap) and [Contributing Guidelines][contributing] to see where you can help out. Prior to the 1.0.0 release, breaking changes should result in a Minor version bump.
18+
__Under active development - APIs will change.__ Check out the [1.0.0 Roadmap](https://github.com/react-bootstrap/react-bootstrap/wiki#100-roadmap) and [Contributing Guidelines][contributing] to see where you can help out. Prior to the 1.0.0 release, deprecations or breaking changes should result in a Minor version bump.
1919

2020
## Docs
2121

0 commit comments

Comments
 (0)