Skip to content

docs: improve README - #71

Open
sabahmax-dev wants to merge 1 commit into
Gunnarguy:mainfrom
sabahmax-dev:webbrain/readme-improvement
Open

sabahmax-dev wants to merge 1 commit into
Gunnarguy:mainfrom
sabahmax-dev:webbrain/readme-improvement

Conversation

@sabahmax-dev

@sabahmax-dev sabahmax-dev commented Sep 18, 2026

Copy link
Copy Markdown

Makes one small, focused improvement to the existing README.

Summary by Sourcery

Documentation:

  • Update the README command to automatically fix detected iCloud conflict copies before signing work.

@sourcery-ai

sourcery-ai Bot commented Sep 18, 2026

Copy link
Copy Markdown
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

The README now documents running the iCloud conflict checker with --fix, clarifying that conflicts should be automatically remediated before signing work.

File-Level Changes

Change Details Files
Update the README’s iCloud conflict-check example to run in automatic fix mode.
  • Add the --fix argument to the documented conflict-check command.
  • Keep the command positioned before signing-related work in the quality workflow.
README.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

Comment thread README.md

# Guard against iCloud conflict copies before any signing work
./scripts/check_icloud_conflicts.sh
./scripts/check_icloud_conflicts.sh --fix

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread README.md

# Guard against iCloud conflict copies before any signing work
./scripts/check_icloud_conflicts.sh
./scripts/check_icloud_conflicts.sh --fix

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
./scripts/check_icloud_conflicts.sh --fix
# Report only; inspect each candidate before deleting anything
./scripts/check_icloud_conflicts.sh

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant