• Home
  • Raw
  • Download

Lines Matching +full:test +full:- +full:msrv

7 …not* be ignored, all contributes are welcome!). These are by no means hard-and-fast rules, as I'm …
10- If backwards compatibility *must* be broken, use deprecation warnings if at all possible before …
11 - This does not apply for security concerns
13 - Parsing of arguments shouldn't slow down usage of the main program
14- This is also true of generating help and usage information (although *slightly* less stringent, …
16- Once parsing is complete, the memory footprint of `clap` should be low since the main program is…
18 …github.com/clap-rs/clap/blob/62eff1f8d3394cef819b4aa7b23a1032fc584f03/src/build/app/debug_asserts.…
19 exit gracefully on *end-user* error
25 - [Discussions](https://github.com/clap-rs/clap/discussions) can be useful for getting help and bra…
26 - [Issues](https://github.com/clap-rs/clap/issues) work well discussing a need and how to solve it
27 - Focus: requirements gathering and design discussions
28 - Sometimes a branch or Draft PR might be used to demonstrate an idea
29 - [PRs](https://github.com/clap-rs/clap/pulls) work well for when the solution has already been dis…
30 - Focus: implementation discussions
35 - Major releases which are reserved for breaking changes
36 - Aspire to at least 6-9 months between releases
37 - Remove all deprecated functionality
38 - Changes in help/error output that could cause glaring inconsistencies in end-user applications
39- Try to minimize new breaking changes to ease user transition and reduce time "we go dark" (unrel…
40- Upon release, a minor release will be made for the previous major that enables `deprecated` feat…
41 - Minor releases which are for minor compatibility changes
42 - Aspire to at least 2 months between releases
43 - Changes to MSRV
44- Wide-spread help/error output changes that would cause minor inconsistencies in end-user applica…
45 - Deprecating existing functionality (behind the `deprecated` feature flag)
46 - Making the `deprecated` feature flag enabled-by-default (only on last planned minor release)
47 - `#[doc(hidden)]` all deprecated items in the prior minor release
48 - Patch releases
49 - 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 inc…
55 - Duplicate functionality, with old functionality marked as "deprecated"
56- Common documentation pattern: `/// Deprecated in [Issue #XXX](https://github.com/clap-rs/clap/is…
57- Common deprecation pattern: `#[cfg_attr(feature = "deprecated", deprecated(since = "X.Y.Z", note…
58 - `deprecated` feature flag is to allow people to process them on their
61 - Please keep API addition and deprecation in separate commits in a PR to make it easier to review
62 - Develop the feature behind an `unstable-<name>` feature flag with a stablization tracking issue (…
66 As we work towards [a more flexible architecture](https://github.com/clap-rs/clap/discussions/3476)…
68 | Version | Status | Support | End-of-Life |
69 |------------------------------------------------------|---------------|---------|-------------|
70 | [v4](https://github.com/clap-rs/clap/tree/master) | active | Features and bug fixes tar…
71-rs/clap/tree/v3-master) | maintenance | Accepting trivial cherry-picks from `master` (i.e. mini…
72 | [v2](https://github.com/clap-rs/clap/tree/v2-master) | deprecated | Only accepting fixes for e…
73 | v1 | unsupported | \- | \- |
75 Note: We have not yet determined the End-of-Life schedule for previous major versions. We will giv…
81 $ make test-full
82 $ make clippy-full
91 …eloping features. In order to see the debug output while running the full test suite or individual…
94 $ cargo test --features debug
97 $ cargo test --test <test_name> --features debug
102 1. `git rebase` into concise commits and remove `--fixup`s or `wip` commits (`git rebase -i HEAD~NU…
103 2. Push your changes back to your fork (`git push origin $your-branch`)
107 - Changes are tested and, if needed, documented
108 - PRs remain small and focused
109 - If needed, we can put changes behind feature flags as they evolve
110 - Commits are atomic (i.e. do a single thing)
111 - Commits are in [Conventional Commit](https://www.conventionalcommits.org/) style
127 4. In **Description**, link the issue you are redeeming _(Ex: `https://github.com/clap-rs/clap/issu…
140 ### Section-specific CONTRIBUTING
142 - [Example CONTRIBUTING](./examples/README.md#contributing)
143 - [Tutorial (builder) CONTRIBUTING](./examples/tutorial_builder/README.md#contributing)
144 - [Tutorial (derive) CONTRIBUTING](./examples/tutorial_derive/README.md#contributing)
145 - [clap_derive CONTRIBUTING](./clap_derive/CONTRIBUTING.md)
147 ### Updating MSRV
149 Search for `MSRV`, for example
151 $ rg --hidden MSRV