Commit graph

31 commits

Author SHA1 Message Date
Ed Page
1a8ffc2a78 docs: Clarify support policy 2022-09-29 09:06:31 -05:00
Ed Page
f925ca84b6 docs: Clarify how to use examples
When we restuctured the examples, we lost the notes on how they should
be structured, so this adds it back in.
2022-09-26 21:06:02 -05:00
Ed Page
69c2d65ca9
docs(contrib): Fix version support table 2022-09-13 15:42:41 -05:00
Ed Page
a9333b7074 docs: Specify that we will support prior major versions
This came up in a [reddit
discussion](https://www.reddit.com/r/rust/comments/vbep9q/clap_32_last_call_before_40/ic91vul/)
and seems like a way we can reduce concerns over clap churn without an
undue burden on maintainers.
2022-09-07 19:12:01 -05:00
Ed Page
1c3159700d docs(contrib): Say why we use feature flag 2022-08-09 10:23:23 -05:00
Ed Page
7515bfeb51 fix: Allow people to opt-in to deprecations
This adds a new `Cargo.toml` feature named `deprecated` that opts
controls whether deprecation warnings show up.  This is starting off as
non-default though that may change (see below).

Benefits
- Allows a staged rollout so a smaller subset of users see new
  deprecations and can report their experience with them before everyone
  sees them.  For example, this reduces the number of people who have to
  deal with #3822.
- This allows people to defer responding to each new batch of
  deprecations and instead do it at once.  This means we should
  reconsider #3616.

The one risk is people who don't follow blog posts and guides having a
harder time upgrading to the next breaking release without the warnings
on by default.  For these users, we reserve the right to make the
`deprecated` feature `default`.  This is most likely to happen in a
minor release that is released in conjunction with the next major
release (e.g. when releasing 4.0.0, we release a 3.3.0 that enables
deprecations by default).  By using a feature, users can still disable
this if they want.

Thanks @joshtriplett for the idea
2022-06-14 10:50:05 -05:00
Ed Page
e2136f9a6a docs(contrib): Align release windows
The README says 6-9 and we want to be clear that it isn't guarenteed
there will be a release then.
2022-02-15 11:26:51 -06:00
Ed Page
5cc913d4b1 docs(contrib): Set release expectations 2022-02-15 10:03:12 -06:00
Malloc Voidstar
6a384a09a2
docs: Fix Conventional Commits link 2022-02-09 21:35:17 -08:00
Ed Page
5674587eb2 docs: Try to steer people to better practices 2022-02-05 09:18:05 -06:00
Ed Page
1b6bf50bf1 docs(contrib): Point out to other contribs 2021-12-07 20:52:27 -06:00
Ed Page
6001e66721 docs(contrib): Note bounty process 2021-12-07 17:45:57 -06:00
Ed Page
5cc16f0681 docs(contrib): Note MSRV process 2021-12-07 17:45:57 -06:00
Ed Page
a98266f140 docs(contrib): Make room for specific sections 2021-12-07 17:45:57 -06:00
mkayaalp
e27ba8c47d docs: Remove references to just (removed by #2923) 2021-11-14 21:46:31 -05:00
Pavan Kumar Sunkara
49aaa5ab0b chore: CI improvements 2021-10-09 19:50:16 +01:00
Ed Page
a77e12e030 docs: Point people to common panic practices 2021-10-05 18:35:46 -05:00
Ivan Tham
34bba9c0d7
Fix double space in CONTRIBUTING.md 2021-06-10 19:21:01 +08:00
Pavan Kumar Sunkara
bddb63effe Compare clap with structopt, fixes #1584 2021-05-26 01:08:12 +01:00
Pavan Kumar Sunkara
49954c28ad Remove unstable feature flag 2021-03-13 11:40:56 +05:30
Pavan Kumar Sunkara
b89163afb6 Update MSRV to 1.46 2020-11-28 11:58:28 +00:00
Marti Raudsepp
cda89a2af1 Fix typos and grammar
Some more fixes in addition to 594c535ba2
* Some I noticed manually.
* Some were found by Topy (https://github.com/intgr/topy), either new
  rules from Typo or new code in clap.
* `etc.` and `e.g.` rules were disabled during the last run.
2020-10-10 16:22:05 +03:00
Pavan Kumar Sunkara
bf65ef3b45 Remove no-default-features test since it's not working 2020-04-10 17:19:26 +02:00
Pavan Kumar Sunkara
b77f159315 Moved to github discussions 2020-04-01 22:32:51 +02:00
Kevin K
60c042481f chore: moves github specific files to .github dir 2016-02-19 01:47:37 -05:00
Kevin K
7aabaa19f7 chore: fixes broken clog link 2015-09-30 13:04:51 -04:00
Alexander Kuvaev
ecc084e32c chore: updated How to Contribute 2015-09-06 02:08:54 +03:00
Alexander Kuvaev
d1ae96c341 chore: fixed README.md and CONTRIBUTING.md 2015-08-30 22:39:57 +03:00
Alexander Kuvaev
69d917d551 chore: fix misspell 2015-08-27 21:14:23 +03:00
Alexander Kuvaev
6609acded1 Added new change type 2015-08-27 20:39:46 +03:00
Kevin K
6f76bd0a07 docs: adds contributing guidelines 2015-05-29 13:13:17 -04:00