chore: use journeys as prs qa contract - #1250
Conversation
Regtest APKDownload bitkit-dev-debug universal APK (expires in 30 days). |
|
3fb2d97 to
0ffee1a
Compare
… into chore/1249-journeys-qa-contract # Conflicts: # journeys/README.md
…-qa-contract # Conflicts: # journeys/README.md
…-qa-contract # Conflicts: # journeys/README.md
|
the Journeys readme is causing conflicts on every Pr merge, can we remove it or use something similar to the changeling strategy? |
jvsena42
left a comment
There was a problem hiding this comment.
One MEDIUM on the QA contract rules (inline). It is docs-only, so it doesn't block. The same gap is on the iOS twin, synonymdev/bitkit-ios#743.
Checked and clean:
- CLAUDE.md→AGENTS.md symlink: the old "not a QA gate" wording is gone everywhere.
QA gateanddeveloper-assistancegrep clean. - The Suites table removal leaves no dangling
#suitesreferences. - Every Capabilities link target exists at head.
pr.mdStep 3 discovery and the\.xml$filter are in place.- The pr.md structure and style target match the template headings and order.
- The library-repo example's Journeys omission is intentional.
The missing locale/font-scale and run-as rows in Capabilities looked like gaps, but the shell-command rule at journeys/README.md:39 covers them, so I'm not raising them.
This comment was marked as outdated.
This comment was marked as outdated.
A PR whose only user-visible change needs a capability the journey environment lacks had no valid `#### Journeys` value: the single empty value asserted no user-visible change, while the rule below it told `/pr` to stop. BLE pairing and the USB permission flow hit this today. Adds `N/A — not drivable; see Manual Tests.` as the second empty value, in the command and the template, and narrows the stop rule to flows a journey could cover. States in `journeys/README.md` that the file tracks capabilities, not journeys, so adding a journey does not touch it. The suites listing this PR removes was edited by every journey PR, which is what made the file conflict on every merge.
# Conflicts: # journeys/README.md
@jvsena42 Right on the cause, and this PR already removes it — it just never said so, which is why it was not obvious from the diff. The conflicting part was What replaces it, I have added a line to the file saying that, so the listing does not grow back:
On the changelog comparison: the reason Worth noting this PR hit that conflict five times while it sat open, which is the strongest evidence for the change that I can offer. |
jvsena42
left a comment
There was a problem hiding this comment.
Delta (71e047ee3): no findings. #### Journeys gets a second empty value for flows the Capabilities table cannot provide, and it requires a matching Manual Tests step. The stop rule no longer fires for BLE or USB-permission-only changes. The README now states that it tracks capabilities, not suites, which answers my conflict question. The master merge 1859b815d resolved the README conflict by dropping master's re-added suite table, which matches the PR's intent. Prose is identical to synonymdev/bitkit-ios#743.
…-qa-contract # Conflicts: # journeys/README.md
|
Merged
The branch still changes only the same four documentation files against |
|
Correction at 501f71a to the LNURL row I added in the previous push. That row called LNURL unavailable except through a custom lnurl-node server, which was wrong. I had taken the claim from the |
…-qa-contract # Conflicts: # journeys/README.md
|
Merged
|
jvsena42
left a comment
There was a problem hiding this comment.
Delta since 71e047ee3 (501f71af1): no findings. The LNURL row now describes the bitkit-docker lnurl-server reached through just run docker, which exists in the Justfile and does the adb reverse forwarding the row claims. The memo-invoice caveat is kept, so the description-hash gap stays recorded.
jvsena42
left a comment
There was a problem hiding this comment.
Approved with one suggestion
…-qa-contract # Conflicts: # journeys/README.md
|
Merged |
…-qa-contract # Conflicts: # journeys/README.md
|
Merged |
Closes #1249
Counterpart: synonymdev/bitkit-ios#743
Description
#### Journeysthe first QA Notes section so that a PR with a user-visible change lists the journeys that prove it, by bare file name withneworupdated, and reviewers drive them on a device instead of reading prose.#### Manual Teststo steps that need a capability the journey environment lacks, and adds a## Capabilitiestable tojourneys/README.mdas the authority for what it provides, so a step is manual by evidence, not by category.#### Automated Checksas a flat list withadded,updated,removed, andrankeywords so the same prefix is never repeated./prand states them inAGENTS.md, and lists theandroidCLI with theandroid-cliskill under Prerequisites because it is how an agent drives journeys.#### Journeysa second empty value,N/A — not drivable; see Manual Tests., for a user-visible change every flow of which needs a capability the journey environment lacks, so BLE pairing and the USB permission flow have a valid value instead of halting/pr.## Suiteslisting fromjourneys/README.md, which was a hand-maintained copy ofls journeys/that every journey PR had to append to, and states the rule that keeps it gone.Out of Scope
journeys/: drift tooling, an identifier index, or a CI check; a journey that fails at review is the drift signal.Design
N/A — no UI changes.
Preview
N/A — no user-visible changes.
QA Notes
Journeys
N/A — no user-visible behaviour change.
Manual Tests
N/A
Automated Checks
### QA Notestemplate section against the counterpart: identical apart from the example test-file name#### Journeysand#### Automated Checksformats: bare names resolve on the PR head, legacy full paths still parsebuild,detektandlinton the PR head: all pass; the e2e workflows skip for a documentation-only diff