You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: AGENTS.md
+21-4Lines changed: 21 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -34,24 +34,41 @@ API, perhaps using `#[doc(hidden)]` helpers when appropriate.
34
34
| Crate |`pub(crate)`|`/src/tests/`|
35
35
| Integration |`pub`|`/tests/`|
36
36
37
+
38
+
## Test Doc-Headers
39
+
40
+
Every test file (module) should maintain an index of the tests contained in the module-doc. The primary purpose is to make it easy to scan the test files to detect duplicates or overlapping coverage. Please opportunistically create if missing.
41
+
37
42
## Cross-Reference Conventions
38
43
39
44
Eagerly corrected when spotted in **any** file!
40
45
41
46
Cross-references use the `§` (section sign) prefix. Every reference
42
-
carries a **package qualifier** — `T-` for Torrust —
43
-
so the target document is never ambiguous.
47
+
carries a **package qualifier** so the target document is never ambiguous.
48
+
ADR references (`ADR-T-001`, `ADR-R-001`, …) are an exception — they
49
+
use their own `ADR-<PREFIX>-<NNN>` form without the `§` prefix.
0 commit comments