clap/clap_complete/CONTRIBUTING.md

# How to Contribute

See the [clap-wide CONTRIBUTING.md](../CONTRIBUTING.md).  This will contain `clap_complete` specific notes.

### Scope

`clap_complete` contains the core completion generators, meaning ones
maintained by the clap maintainers that get priority for features and fixes.
Additional, including contributor-maintained generators can also be contributed
to the clap repo and sit alongside `clap_complete` in a `clap_complete_<name>`
crate.
fix(complete): Give crates more specific names `clap_generate` originally intended to be "generate anything". With `fig`, we already broke one part out. With #3174's man support, we are also looking at keeping it separate: - More freedom to iterate on the API - Uniqueness (and potential weight) of its dependencies - man generation is normally more for distribution while completions are a mix of being distributed with the app or the app generating the completions (which will be exacerbated if we move most completion parsing logic to be in Rust) So `clap_generate` is having a lot more limited of a role than the original name conveys. I worry the generic name will be a hindrance to people discovering and using it (yes, documentation can help but there are limits). I hesitated because we are on the verge of releasing 3.0. However, doing it even later will be even more disruptive because more people will be using it (crates.io lists ~70 people using `clap_generate`). To ease things, we are still releasing `clap_generate` as a wrapper around `clap_complete`. 2021-12-31 17:59:15 +00:00			`# How to Contribute`

			See the [clap-wide CONTRIBUTING.md](../CONTRIBUTING.md). This will contain `clap_complete` specific notes.

			`### Scope`

			`clap_complete` contains the core completion generators, meaning ones
			`maintained by the clap maintainers that get priority for features and fixes.`
			`Additional, including contributor-maintained generators can also be contributed`
			to the clap repo and sit alongside `clap_complete` in a `clap_complete_<name>`
			`crate.`