Skip to content

Commit d74d656

Browse files
committed
Note about api deprecation
1 parent c02c784 commit d74d656

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,15 @@ that also:
1414
- Updates examples
1515
- Updates the docs
1616

17+
## API Deprecation
18+
19+
Introduce new API in minor versions, remove old APIs in major versions.
20+
21+
For example, if the current version is 2.3 and we change `<Router/>`
22+
`<Rooter/>` the next release will be 2.4 that contains both APIs but
23+
`<Router/>` would log a warning to the console. When 3.0 is released,
24+
`<Router/>` would be completely removed.
25+
1726
### Development
1827

1928
- `npm test` will fire up a karma test runner and watch for changes

0 commit comments

Comments
 (0)