Skip to content

Commit 2bafb9b

Browse files
committed
docs(contrib): Define a compatibility policy for help/error output
1 parent a41ca2e commit 2bafb9b

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

CONTRIBUTING.md

+3
Original file line numberDiff line numberDiff line change
@@ -35,16 +35,19 @@ Our releases fall into one of:
3535
- Major releases which are reserved for breaking changes
3636
- Aspire to at least 6-9 months between releases
3737
- Remove all deprecated functionality
38+
- Changes in help/error output that could cause glaring inconsistencies in end-user applications
3839
- Try to minimize new breaking changes to ease user transition and reduce time "we go dark" (unreleased feature-branch)
3940
- Upon release, a minor release will be made for the previous major that enables `deprecated` feature by default
4041
- Minor releases which are for minor compatibility changes
4142
- Aspire to at least 2 months between releases
4243
- Changes to MSRV
44+
- Wide-spread help/error output changes that would cause minor inconsistencies in end-user applications
4345
- Deprecating existing functionality (behind the `deprecated` feature flag)
4446
- Making the `deprecated` feature flag enabled-by-default (only on last planned minor release)
4547
- `#[doc(hidden)]` all deprecated items in the prior minor release
4648
- Patch releases
4749
- One for every user-facing, user-contributed PR (i.e. release early, release often)
50+
- Changes in help/error output that are one-off or improving consistency so as to not increase inconsistency with end-user applications
4851

4952
If your change does not fit within a "patch" release, please coordinate with the clap maintainers for how to handle the situation.
5053

0 commit comments

Comments
 (0)