about summary refs log tree commit diff
diff options
context:
space:
mode:
authorJosh Triplett <josh@joshtriplett.org>2023-07-05 14:03:37 -0700
committerJosh Triplett <josh@joshtriplett.org>2023-07-05 14:03:37 -0700
commit08a997eea28c75e23e5b765de1578c8537ac16bf (patch)
tree7e7f5721b7590cf1c5cf286c107d86374ede0010
parent5dac6b320be868f898a3c753934eabc79ff2e406 (diff)
downloadrust-08a997eea28c75e23e5b765de1578c8537ac16bf.tar.gz
rust-08a997eea28c75e23e5b765de1578c8537ac16bf.zip
style-guide: Add section on bugs, and resolving bugs
-rw-r--r--src/doc/style-guide/src/README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/src/doc/style-guide/src/README.md b/src/doc/style-guide/src/README.md
index b8aa64ba14f..9955f95e3f0 100644
--- a/src/doc/style-guide/src/README.md
+++ b/src/doc/style-guide/src/README.md
@@ -32,6 +32,19 @@ This should not be interpreted as forbidding developers from following a
 non-default style, or forbidding tools from adding any particular configuration
 options.
 
+## Bugs
+
+If the style guide differs from rustfmt, that may represent a bug in rustfmt,
+or a bug in the style guide; either way, please report it to the style team or
+the rustfmt team or both, for investigation and fix.
+
+If implementing a new formatting tool based on the style guide and default Rust
+style, please test it on the corpus of existing Rust code, and avoid causing
+widespread breakage. The implementation and testing of such a tool may surface
+bugs in either the style guide or rustfmt, as well as bugs in the tool itself.
+
+We typically resolve bugs in a fashion that avoids widespread breakage.
+
 ## Formatting conventions
 
 ### Indentation and line width