diff --git a/.agents/commands/pr.md b/.agents/commands/pr.md index 05f1cc9bf..eebfd799c 100644 --- a/.agents/commands/pr.md +++ b/.agents/commands/pr.md @@ -94,6 +94,7 @@ This PR adds support for... - Each list item should start with a verb (Adds, Fixes, Updates, Removes, Refactors, etc.) **Description Rules:** +- One bullet per change under `### Description`: what changed and why, in one sentence each (`Adds X so that Y`, `Fixes X because Y`) - Base content around all commit messages in the branch - Use branch name as the conceptual anchor - Match writing style of recent PRs @@ -102,6 +103,12 @@ This PR adds support for... - Minimize code and file references like `TheClassName` or `someFunctionName`, `thisFileName.ext` - Exception: for refactoring PRs (1:10 ratio of functionality to code changes), more technical detail is ok +**Out of Scope (`#### Out of Scope`, a subsection at the end of `### Description`):** +- Required for `feat`, `fix`, and `refactor` PRs: one bullet per item the PR deliberately leaves out, with the file or area it covers when there is one (`path/or/area: item`); `None.` when nothing is left out +- Not needed for version bumps, changelog-only changes, dependency bumps, and release PRs; other `chore`, `docs`, and `test` PRs include it at the author's discretion +- Derive candidates from commit messages, linked issues, and review discussion (deferred follow-ups, adjacent behaviour left unchanged); ask the user when unsure +- Reviewers, human and automated, read the bullets as the author's non-goals + **Custom Instructions:** When the user provides custom instructions after `--`: - Parse any referenced commit SHAs and read their full messages @@ -131,7 +138,8 @@ When the user provides custom instructions after `--`: #### Automated Checks ``` - Keep local verification commands, `xcodebuild`, Swift tests, SwiftFormat, translation validation, 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. -- Use `#### Automated Checks` to summarize automated verification evidence, prioritizing coverage added, modified, or removed with file paths and a short explanation. +- Use `#### Automated Checks` to summarize automated verification evidence, prioritizing coverage added, modified, or removed, each with the test file name and a short explanation. +- Reference test files by bare file name only (e.g. `TransferViewModelTests.swift`), 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. `BitkitTests/SendTests.swift` vs `BitkitUITests/SendTests.swift`). - For removed automated coverage, state why it was removed. - 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. - 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. @@ -179,9 +187,9 @@ Concrete style target: - [ ] **5b.** back: returns to Connections List. - [ ] **6.** `regression:` Channel Detail → tap Close Connection: works. #### Automated Checks -- Unit tests added: cover invoice timeout handling in `BitkitTests/TransferViewModelTests.swift`. -- Unit tests modified: update channel navigation assertions in `BitkitTests/ChannelDetailsViewModelTests.swift`. -- Test coverage removed: delete stale mock-only assertions from `BitkitTests/OldFlowTests.swift` because the flow no longer exists. +- Unit tests added: cover invoice timeout handling in `TransferViewModelTests.swift`. +- Unit tests modified: update channel navigation assertions in `ChannelDetailsViewModelTests.swift`. +- Test coverage removed: delete stale mock-only assertions from `OldFlowTests.swift` because the flow no longer exists. - CI: standard build and test checks run by the PR bot. ``` diff --git a/.agents/commands/release.md b/.agents/commands/release.md index f154965e7..6d65e70c6 100644 --- a/.agents/commands/release.md +++ b/.agents/commands/release.md @@ -130,7 +130,11 @@ Bump version to {newVersionName} (build {newBuildNumber}) for release. N/A — no UI changes. -### Screenshot / Video +### Preview + +N/A + +### QA Notes N/A ``` diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 526002e03..a62e7e9e8 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,23 +1,29 @@ + + ### Description -Please include a summary of changes and which issues are fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. + -### Linked Issues/Tasks +#### Out of Scope -Add any links to GitHub issues or Asana tasks that are relevant to this pull request. + ### Design - + -### Screenshot / Video +### Preview -Insert relevant screenshot / recording + + +### QA Notes + +#### Manual Tests + + + +#### Automated Checks + +