Skip to content

Commit 603ab3d

Browse files
committed
Add a little clarity around who is responsible for what
1 parent d5c6fb1 commit 603ab3d

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

docs/authoring.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,9 @@ Tests in <https://github.com/rust-lang/rust> can be linked to rules in the refer
105105

106106
Tests in the `tests` directory can be annotated with the `//@ reference: x.y.z` header to link it to a rule. The header can be specified multiple times if a single file covers multiple rules.
107107

108-
You *should* when possible make sure every rule has a test associated with it. This is beneficial for reviewers to see the behavior and readers who may want to see examples of particular behaviors. When adding new rules, you should wait until the reference side is approved before submitting a PR to `rust-lang/rust` (to avoid churn if we decide on different names).
108+
Compiler developers are not expected to add `reference` annotations to tests. However, if they do want to help, their cooperation is very welcome. Reference authors and editors are responsible for making sure every rule has a test associated with it.
109+
110+
The tests are beneficial for reviewers to see the behavior of a rule. It is also a benefit to readers who may want to see examples of particular behaviors. When adding new rules, you should wait until the reference side is approved before submitting a PR to `rust-lang/rust` (to avoid churn if we decide on different names).
109111

110112
Prefixed rule names should not be used in tests. That is, do not use something like `asm.rules` when there are specific rules like `asm.rules.reg-not-input`.
111113

0 commit comments

Comments
 (0)