mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #3486 from scampi/issue-3197

Browse Source 
add document describing rustfmt's stabilisation process
This commit is contained in:
Seiichi Uchida 2019-05-09 13:37:34 +09:00 committed by GitHub
commit a2264cb549
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
Processes.md Normal file
View File

@ -0,0 +1,22 @@
This document outlines processes regarding management of rustfmt.
# Stabilising an Option
In this Section, we describe how to stabilise an option of the rustfmt's configration.
## Conditions
- The design and implementation of the option are sound and clean.
- The option is well tested, both in unit tests and, optimally, in real usage.
- There is no open bug about the option that prevents its use.
## Steps
Open a pull request that closes the tracking issue. The tracking issue is listed beside the option in `Configurations.md`.
- Update the `Config` enum marking the option as stable.
- Update the the `Configuration.md` file marking the option as stable.
## After the stabilisation
The option should remain backward-compatible with previous parameters of the option. For instance, if the option is an enum `enum Foo { Alice, Bob }` and the variant `Foo::Bob` is removed/renamed, existing use of the `Foo::Bob` variant should map to the new logic. Breaking changes can be applied under the condition they are version-gated.