Skip to content

Commit 71bde0c

Browse files
authored
docs: add per file sections
1 parent 821c7fc commit 71bde0c

4 files changed

Lines changed: 60 additions & 40 deletions

File tree

commands/bitcoinui.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -31,26 +31,31 @@ If `$ARGUMENTS` is empty, ask: "Using the bitcoinui command for an iOS review. W
3131
## Output Format
3232

3333
Start directly with the `BITCOINUI` block; do not add any preamble text before it.
34+
If a folder is reviewed, list each file as its own section (file path + findings + severities).
35+
Omit any file section with 0 findings (do not list zero-findings files).
3436
Omit any severity section with 0 findings (including Low).
3537

3638
```
3739
BITCOINUI
3840
39-
[file-or-folder]
40-
Findings: X high, X medium, X low
41-
42-
High
43-
1) [UX L42] Missing warning for fee > amount
44-
Fix: Add a warning state when fee >= 50% of amount.
45-
Ref: Bitcoin Design Guide — Send fees https://bitcoin.design/guide/daily-spending-wallet/sending/send-fees/
41+
SendFeeView.swift
42+
Findings: 0 high, 2 medium, 0 low
4643
4744
Medium
48-
1) [A11Y L18] Icon-only button has no label
45+
1) [UX L88] Fee picker lacks a high-fee warning
46+
Fix: Add a warning when fee >= 50% of amount.
47+
Ref: Bitcoin Design Guide — Send fees https://bitcoin.design/guide/daily-spending-wallet/sending/send-fees/
48+
2) [A11Y L42] Icon-only close button has no label
4949
Fix: Add accessibilityLabel("Close")
5050
Ref: iOS HIG — Accessibility https://developer.apple.com/design/human-interface-guidelines/accessibility
5151
52-
Low
53-
1) ...
52+
ReceiveView.swift
53+
Findings: 0 high, 1 medium, 0 low
54+
55+
Medium
56+
1) [QR L19] QR payload uses uri directly; bech32 should be uppercased for QR only
57+
Fix: Uppercase only the bech32 address for QR encoding.
58+
Ref: BIP173 https://github.com/bitcoin/bips/blob/master/bip-0173.mediawiki
5459
```
5560

5661
## Guidance

site/bitcoinui.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -31,26 +31,31 @@ If `$ARGUMENTS` is empty, ask: "Using the bitcoinui command for an iOS review. W
3131
## Output Format
3232

3333
Start directly with the `BITCOINUI` block; do not add any preamble text before it.
34+
If a folder is reviewed, list each file as its own section (file path + findings + severities).
35+
Omit any file section with 0 findings (do not list zero-findings files).
3436
Omit any severity section with 0 findings (including Low).
3537

3638
```
3739
BITCOINUI
3840
39-
[file-or-folder]
40-
Findings: X high, X medium, X low
41-
42-
High
43-
1) [UX L42] Missing warning for fee > amount
44-
Fix: Add a warning state when fee >= 50% of amount.
45-
Ref: Bitcoin Design Guide — Send fees https://bitcoin.design/guide/daily-spending-wallet/sending/send-fees/
41+
SendFeeView.swift
42+
Findings: 0 high, 2 medium, 0 low
4643
4744
Medium
48-
1) [A11Y L18] Icon-only button has no label
45+
1) [UX L88] Fee picker lacks a high-fee warning
46+
Fix: Add a warning when fee >= 50% of amount.
47+
Ref: Bitcoin Design Guide — Send fees https://bitcoin.design/guide/daily-spending-wallet/sending/send-fees/
48+
2) [A11Y L42] Icon-only close button has no label
4949
Fix: Add accessibilityLabel("Close")
5050
Ref: iOS HIG — Accessibility https://developer.apple.com/design/human-interface-guidelines/accessibility
5151
52-
Low
53-
1) ...
52+
ReceiveView.swift
53+
Findings: 0 high, 1 medium, 0 low
54+
55+
Medium
56+
1) [QR L19] QR payload uses uri directly; bech32 should be uppercased for QR only
57+
Fix: Uppercase only the bech32 address for QR encoding.
58+
Ref: BIP173 https://github.com/bitcoin/bips/blob/master/bip-0173.mediawiki
5459
```
5560

5661
## Guidance

site/skills/bitcoinui/SKILL.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -29,26 +29,31 @@ Review iOS SwiftUI code and screens for Bitcoin-specific UX correctness, iOS HIG
2929
## Output Format
3030

3131
Start directly with the `BITCOINUI` block; do not add any preamble text before it.
32+
If a folder is reviewed, list each file as its own section (file path + findings + severities).
33+
Omit any file section with 0 findings (do not list zero-findings files).
3234
Omit any severity section with 0 findings (including Low).
3335

3436
```
3537
BITCOINUI
3638
37-
[file-or-folder]
38-
Findings: X high, X medium, X low
39-
40-
High
41-
1) [UX L42] Missing warning for fee > amount
42-
Fix: Add a warning state when fee >= 50% of amount.
43-
Ref: Bitcoin Design Guide — Send fees https://bitcoin.design/guide/daily-spending-wallet/sending/send-fees/
39+
SendFeeView.swift
40+
Findings: 0 high, 2 medium, 0 low
4441
4542
Medium
46-
1) [A11Y L18] Icon-only button has no label
43+
1) [UX L88] Fee picker lacks a high-fee warning
44+
Fix: Add a warning when fee >= 50% of amount.
45+
Ref: Bitcoin Design Guide — Send fees https://bitcoin.design/guide/daily-spending-wallet/sending/send-fees/
46+
2) [A11Y L42] Icon-only close button has no label
4747
Fix: Add accessibilityLabel("Close")
4848
Ref: iOS HIG — Accessibility https://developer.apple.com/design/human-interface-guidelines/accessibility
4949
50-
Low
51-
1) ...
50+
ReceiveView.swift
51+
Findings: 0 high, 1 medium, 0 low
52+
53+
Medium
54+
1) [QR L19] QR payload uses uri directly; bech32 should be uppercased for QR only
55+
Fix: Uppercase only the bech32 address for QR encoding.
56+
Ref: BIP173 https://github.com/bitcoin/bips/blob/master/bip-0173.mediawiki
5257
```
5358

5459
## References

skills/bitcoinui/SKILL.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -29,26 +29,31 @@ Review iOS SwiftUI code and screens for Bitcoin-specific UX correctness, iOS HIG
2929
## Output Format
3030

3131
Start directly with the `BITCOINUI` block; do not add any preamble text before it.
32+
If a folder is reviewed, list each file as its own section (file path + findings + severities).
33+
Omit any file section with 0 findings (do not list zero-findings files).
3234
Omit any severity section with 0 findings (including Low).
3335

3436
```
3537
BITCOINUI
3638
37-
[file-or-folder]
38-
Findings: X high, X medium, X low
39-
40-
High
41-
1) [UX L42] Missing warning for fee > amount
42-
Fix: Add a warning state when fee >= 50% of amount.
43-
Ref: Bitcoin Design Guide — Send fees https://bitcoin.design/guide/daily-spending-wallet/sending/send-fees/
39+
SendFeeView.swift
40+
Findings: 0 high, 2 medium, 0 low
4441
4542
Medium
46-
1) [A11Y L18] Icon-only button has no label
43+
1) [UX L88] Fee picker lacks a high-fee warning
44+
Fix: Add a warning when fee >= 50% of amount.
45+
Ref: Bitcoin Design Guide — Send fees https://bitcoin.design/guide/daily-spending-wallet/sending/send-fees/
46+
2) [A11Y L42] Icon-only close button has no label
4747
Fix: Add accessibilityLabel("Close")
4848
Ref: iOS HIG — Accessibility https://developer.apple.com/design/human-interface-guidelines/accessibility
4949
50-
Low
51-
1) ...
50+
ReceiveView.swift
51+
Findings: 0 high, 1 medium, 0 low
52+
53+
Medium
54+
1) [QR L19] QR payload uses uri directly; bech32 should be uppercased for QR only
55+
Fix: Uppercase only the bech32 address for QR encoding.
56+
Ref: BIP173 https://github.com/bitcoin/bips/blob/master/bip-0173.mediawiki
5257
```
5358

5459
## References

0 commit comments

Comments
 (0)