Skip to content

Commit 08a997e

Browse files
committed
style-guide: Add section on bugs, and resolving bugs
1 parent 5dac6b3 commit 08a997e

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

src/doc/style-guide/src/README.md

+13
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,19 @@ This should not be interpreted as forbidding developers from following a
3232
non-default style, or forbidding tools from adding any particular configuration
3333
options.
3434

35+
## Bugs
36+
37+
If the style guide differs from rustfmt, that may represent a bug in rustfmt,
38+
or a bug in the style guide; either way, please report it to the style team or
39+
the rustfmt team or both, for investigation and fix.
40+
41+
If implementing a new formatting tool based on the style guide and default Rust
42+
style, please test it on the corpus of existing Rust code, and avoid causing
43+
widespread breakage. The implementation and testing of such a tool may surface
44+
bugs in either the style guide or rustfmt, as well as bugs in the tool itself.
45+
46+
We typically resolve bugs in a fashion that avoids widespread breakage.
47+
3548
## Formatting conventions
3649

3750
### Indentation and line width

0 commit comments

Comments
 (0)