docs: improve README - #71
sabahmax-dev wants to merge 1 commit into
Conversation
Reviewer's guide (collapsed on small PRs)Reviewer's GuideThe README now documents running the iCloud conflict checker with File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Hey - I've found 2 issues
Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments
### Comment 1
<location path="README.md" line_range="188" />
<code_context>
# Guard against iCloud conflict copies before any signing work
-./scripts/check_icloud_conflicts.sh
+./scripts/check_icloud_conflicts.sh --fix
```
</code_context>
<issue_to_address>
**issue (bug_risk):** When an iCloud conflict copy exists, `build_simulator_smoke.sh` aborts during the preceding build because it runs `check_icloud_conflicts.sh --quiet` and requires a clean tree; the README's later `--fix` command is therefore never reached.
**Triggers:** When the working tree contains an iCloud conflict copy before running the documented build sequence.
**Suggested fix:** Move the `--fix` command before `./scripts/build_simulator_smoke.sh`, or change the build script to repair conflicts automatically.
</issue_to_address>
### Comment 2
<location path="README.md" line_range="188" />
<code_context>
# Guard against iCloud conflict copies before any signing work
-./scripts/check_icloud_conflicts.sh
+./scripts/check_icloud_conflicts.sh --fix
```
</code_context>
<issue_to_address>
**issue (bug_risk):** The documented command can delete legitimate user files or directories whose names end in patterns such as `Notes 2.md` or `Archive 2`, because the script treats every matching path as an iCloud conflict and removes it with `rm -rf` without verifying that an original exists.
**Triggers:** When the repository contains a legitimate path matching the script's conflict-copy filename globs.
**Suggested fix:** Make the repair mode verify each candidate against its original and require confirmation for ambiguous matches; otherwise document the safer report-only command and tell users to inspect before deletion.
```suggestion
# Report only; inspect each candidate before deleting anything
./scripts/check_icloud_conflicts.sh
```
</issue_to_address>|
|
||
| # Guard against iCloud conflict copies before any signing work | ||
| ./scripts/check_icloud_conflicts.sh | ||
| ./scripts/check_icloud_conflicts.sh --fix |
There was a problem hiding this comment.
issue (bug_risk): When an iCloud conflict copy exists, build_simulator_smoke.sh aborts during the preceding build because it runs check_icloud_conflicts.sh --quiet and requires a clean tree; the README's later --fix command is therefore never reached.
Triggers: When the working tree contains an iCloud conflict copy before running the documented build sequence.
Suggested fix: Move the --fix command before ./scripts/build_simulator_smoke.sh, or change the build script to repair conflicts automatically.
|
|
||
| # Guard against iCloud conflict copies before any signing work | ||
| ./scripts/check_icloud_conflicts.sh | ||
| ./scripts/check_icloud_conflicts.sh --fix |
There was a problem hiding this comment.
issue (bug_risk): The documented command can delete legitimate user files or directories whose names end in patterns such as Notes 2.md or Archive 2, because the script treats every matching path as an iCloud conflict and removes it with rm -rf without verifying that an original exists.
Triggers: When the repository contains a legitimate path matching the script's conflict-copy filename globs.
Suggested fix: Make the repair mode verify each candidate against its original and require confirmation for ambiguous matches; otherwise document the safer report-only command and tell users to inspect before deletion.
| ./scripts/check_icloud_conflicts.sh --fix | |
| # Report only; inspect each candidate before deleting anything | |
| ./scripts/check_icloud_conflicts.sh |
Makes one small, focused improvement to the existing README.
Summary by Sourcery
Documentation: