The Setup Guide tells a user whose rule is on and refused to switch one on
Maintainers usually reply within 1 day
A pull request for this has already been merged.
- #233 by @JWhite212 — merged
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 67/100
- Issue type
- Bug
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- macos, swift
- Domain
- documentation, testing
Research direction
Start with SetupText.swift:555 and :746 to trace how the first-rule step and rule counts produce the misleading message. For .loadedWithProblems and .notReloaded(.everyRuleRefused), use the proposed separate sentence directing users to Edit Rules… to see why. Update the sanctioned assertion in FirstRuleWayOnTests.swift:52-56 and check the wording against SetupTextTests; done means the affected cases show the new sentence and the other cases stay unchanged.
Written by the indexing model from the issue text.
Description
Audit row: B30, Defects (added by #193). Line numbers are those of 4553590. Owner decision: the fix changes what a test asserts.
What is wrong. A user whose only rule is on, sounds, and is refused (for example, a blank final Shortcut name) is told by the Setup Guide's first-rule step: "You have rules, and none is switched on and makes a sound or speaks. Choose Edit Rules… to switch one on and give it a sound, or make another." The rule is on and does make a sound. firstRuleHasRules (SetupText.swift:555) is shown when hasRules counts refused rules (:746), while "makes a sound" counts only rules in effect. The status line above it is right.
Options
- (Recommended) For
.loadedWithProblemsand.notReloaded(.everyRuleRefused)the step says a sentence of its own: that the rules that are on could not be used, and Edit Rules… shows why. The sanctioned test edit isFirstRuleWayOnTests.swift:52-56, whose loop assertsfirstRuleHasRulesfor.loadedWithProblems; that status would assert the new sentence.:58-60(the sentence's own words) and every other case stay. - Leave it.
Pins: grep -rn 'firstRuleHasRules' Tests | wc -l → 4; SetupTextTests checks every step's words, so the new sentence must pass those checks.
Hold: not merged before v1.1.0 is tagged (owner, 2026-11-06).
Prevention: Guard added: the edited assertion.
Size: S.
- Dominant language
- Swift
- Stars
- 2
- Forks
- 0
- Avg merge
- 1h 7m
- Merged PRs (30d)
- 152
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from JWhite212/SignalLadder
-
bug
Difficulty 3/5 Half a day Newbie friendliness 38/100
JWhite212/SignalLadder#216 · 2 comments ·
Maintainers usually reply within 1 day
All issues in JWhite212/SignalLadder
Similar issues
-
area:shell order:5 status:ready type:bug
Difficulty 1/5 Under an hour Newbie friendliness 85/100
krystianslowik/arkt#899 ·
Maintainers usually reply within 1 day
-
help wanted roadmap tests
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
🐞 bug 💠 component 🔍 triage v4 🧰 library
Difficulty 1/5 Under an hour Newbie friendliness 72/100
Orange-OpenSource/ouds-ios#1875 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 78/100
521xueweihan/HelloGitHub#4295 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100