Skip to content

Commit d450ae7

Browse files
describe upgrade path, deprecate from_bufread functions
1 parent 148d989 commit d450ae7

4 files changed

Lines changed: 315 additions & 89 deletions

File tree

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ rpassword = "7.4"
1616

1717
See examples and docs at [https://docs.rs/rpassword](https://docs.rs/rpassword).
1818

19+
See the upgrade path in [UPGRADE.md](UPGRADE.md).
20+
1921
## License
2022

2123
The source code is released under the Apache 2.0 license.

UPGRADE.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Upgrade Policy for `rpassword`
2+
3+
## Overview
4+
This policy outlines the versioning and upgrade path for `rpassword`.
5+
6+
Please report any upgrading issues or feedback to the project's issue tracker.
7+
8+
## Versioning Rules
9+
10+
### Patch Versions (`x.y.Z`)
11+
- **Definition**: Bug fixes, performance improvements, and minor documentation updates.
12+
- **Compatibility**: Fully backward-compatible. No breaking changes.
13+
- **User Action**: Safe to upgrade without code modifications.
14+
15+
### Minor Versions (`x.Y.z`)
16+
- **Definition**: New features, enhancements, and deprecations.
17+
- **Compatibility**: Backward-compatible. Deprecated APIs remain functional but emit warnings.
18+
- **User Action**:
19+
1. Upgrade to the latest minor version.
20+
2. Address deprecation warnings to prepare for the next major version.
21+
22+
### Major Versions (`X.y.z`)
23+
- **Definition**: Breaking changes, API redesigns, or significant architectural shifts.
24+
- **Compatibility**: Not backward-compatible. Deprecated APIs may be removed.
25+
- **User Action**:
26+
1. Upgrade to the latest minor version of the current major release.
27+
2. Fix all deprecation warnings.
28+
3. Upgrade to the next major version.

0 commit comments

Comments
 (0)