Skip to content

Commit a4dbd43

Browse files
committed
docs: reference test files by name in pr notes
1 parent e3ea871 commit a4dbd43

2 files changed

Lines changed: 6 additions & 4 deletions

File tree

.agents/commands/pr.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,8 @@ When the user provides custom instructions after `--`:
136136
#### Automated Checks
137137
```
138138
- Keep local verification commands, Gradle tasks, detekt, lint, unit tests, build passes, cargo test, cargo clippy, npm test, typecheck, CI coverage, or similar automated checks out of `#### Manual Tests`; summarize them under `#### Automated Checks` when they add useful context.
139-
- Use `#### Automated Checks` to summarize automated verification evidence, prioritizing coverage added, modified, or removed with file paths and a short explanation.
139+
- Use `#### Automated Checks` to summarize automated verification evidence, prioritizing coverage added, modified, or removed, each with the test file name and a short explanation.
140+
- Reference test files by bare file name only (e.g. `HwWalletRepoTest.kt`), never the full path. Only when two referenced test files share the same name, prefix the shortest leading path segment(s) that disambiguate them (e.g. `repositories/FooTest.kt` vs `viewmodels/FooTest.kt`).
140141
- For removed automated coverage, state why it was removed.
141142
- Do not list standard CI or PR bot commands as checkbox items just because they run for every PR. If standard CI coverage is worth mentioning, summarize it in one sentence.
142143
- List raw commands only when they were run locally, are non-standard, use special flags or environment values, validate workflow behavior, or explain a meaningful verification gap.
@@ -184,9 +185,9 @@ Concrete style target:
184185
- [ ] **5b.** back: returns to Connections List.
185186
- [ ] **6.** `regression:` Channel Detail → tap Close Connection: works.
186187
#### Automated Checks
187-
- Unit tests added: cover invoice timeout handling in `app/src/test/.../SendInvoiceTest.kt`.
188-
- Unit tests modified: update channel navigation assertions in `app/src/test/.../ChannelDetailTest.kt`.
189-
- Test coverage removed: delete stale mock-only assertions from `app/src/test/.../OldFlowTest.kt` because the flow no longer exists.
188+
- Unit tests added: cover invoice timeout handling in `SendInvoiceTest.kt`.
189+
- Unit tests modified: update channel navigation assertions in `ChannelDetailTest.kt`.
190+
- Test coverage removed: delete stale mock-only assertions from `OldFlowTest.kt` because the flow no longer exists.
190191
- CI: standard compile, unit test, and detekt checks run by the PR bot.
191192
```
192193

AGENTS.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -229,6 +229,7 @@ suspend fun getData(): Result<Data> = withContext(Dispatchers.IO) {
229229
- ALWAYS add new localizable string resources in alphabetical order in `strings.xml`
230230
- NEVER add string resources for strings used only in dev settings screens and previews and never localize acronyms
231231
- ALWAYS use template in `.github/pull_request_template.md` for PR descriptions
232+
- ALWAYS reference test files in PR descriptions/QA Notes by bare file name only (e.g. `HwWalletRepoTest.kt`), NEVER the full path; only when two referenced test files share the same name, prefix the shortest leading path segment(s) that disambiguate them (e.g. `repositories/FooTest.kt` vs `viewmodels/FooTest.kt`)
232233
- ALWAYS wrap `ULong` numbers with `USat` in arithmetic operations, to guard against overflows
233234
- PREFER to use one-liners with `run {}` when applicable, e.g. `override fun someCall(value: String) = run { this.value = value }`
234235
- ALWAYS add imports instead of inline fully-qualified names

0 commit comments

Comments
 (0)