Skip to content

Commit a2264cb

Browse files
authored
Merge pull request #3486 from scampi/issue-3197
add document describing rustfmt's stabilisation process
2 parents da1e3c9 + c7d6dc4 commit a2264cb

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

Processes.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
This document outlines processes regarding management of rustfmt.
2+
3+
# Stabilising an Option
4+
5+
In this Section, we describe how to stabilise an option of the rustfmt's configration.
6+
7+
## Conditions
8+
9+
- The design and implementation of the option are sound and clean.
10+
- The option is well tested, both in unit tests and, optimally, in real usage.
11+
- There is no open bug about the option that prevents its use.
12+
13+
## Steps
14+
15+
Open a pull request that closes the tracking issue. The tracking issue is listed beside the option in `Configurations.md`.
16+
17+
- Update the `Config` enum marking the option as stable.
18+
- Update the the `Configuration.md` file marking the option as stable.
19+
20+
## After the stabilisation
21+
22+
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.

0 commit comments

Comments
 (0)