docs(repo-health): clone URL, uv run, and CLI bug template by cursor[bot] · Pull Request #1258 · abhimehro/ctrld-sync

cursor · 2026-09-17T12:09:28Z

Submitting a Pull Request

Summary

Weekly housekeeping (2026-09-17): docs and issue template only. Supersedes draft #1248 (still unmerged).

Branch Naming

docs/<short-description> (cloud unique prefix cursor-agent/repository-health-housekeeping-4aac)

Before Opening a PR

Docs/template only. uv run pytest --collect-only -q → 590 tests (unchanged).

PR Description

What Changed and Why

Re-land #1248 (still draft on main):

Clone URL github.com/your-username/ctrld-sync.git → abhimehro/ctrld-sync.
Quick start used bare python main.py; AGENTS.md/CONTRIBUTING already use uv run python.
CI table listed only Sync / Bandit / Test; added Lint, Typecheck, and Performance.

New vs last week:

WARP.md still told people to edit DEFAULT_FOLDER_URLS in main.py; the list lives in config.py, and config.yaml / --config is the file-based path.
Bug report template was the GitHub web-app default (Browser / Smartphone); replaced with CLI/uv fields and a TOKEN/PROFILE redaction note.

Did not bump actions/ai-inference (#1233 / Dependabot #1204). Did not add CODEOWNERS (none of the sibling repos have one).

Include:

A summary of what changed and why
How to test or verify the change
Any relevant issue numbers (e.g., Closes #123)

Security Implications

No secrets or credentials are introduced or exposed by this change

Secrets

TOKEN (Control D API token) and PROFILE (profile ID) are required only for live runs against the API. Not used by this PR.

Checklist

Commit messages are clear and descriptive
Documentation updated if behaviour changed (README, docstrings, etc.)
No secrets, credentials, tokens, profiles, or .env files are included in this PR

Please keep this draft until reviewed.

═══ ELIR ═══
PURPOSE: Mechanical docs/template hygiene so clone/run/CI and bug reports match the Python 3.13 + uv CLI.
SECURITY: No secrets, no workflow pin changes, no ai-inference bump.
FAILS IF: someone still follows the old #1248 branch instead of this one.
VERIFY: README clone URL is abhimehro/ctrld-sync; WARP.md names config.py; bug template has no Browser/Smartphone.
MAINTAIN: Close or supersede leftover draft #1248 after merge; hold Models 410 on summary.yml.

Re-lands the unmerged 2026-09-10 housekeeping (#1248): clone abhimehro/ctrld-sync, match AGENTS.md uv run commands, and list lint/typecheck/performance beside test/sync/bandit. Co-authored-by: abhimehrotra <abhimehrotra@bears.mybrcc.edu>

DEFAULT_FOLDER_URLS lives in config.py, not main.py; document config.yaml/--config as the file-based path. Replace the web-app bug report template with CLI/uv environment fields. Co-authored-by: abhimehrotra <abhimehrotra@bears.mybrcc.edu>

trunk-io · 2026-09-17T12:09:31Z

😎 This pull request was merged.

coderabbitai · 2026-09-17T12:09:33Z

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 5cef4a8a-69a1-456d-b657-7c48216c9c61

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

🔍 Trigger review

✨ Finishing Touches

✨ Simplify code

Commit to this branch
Create a new PR

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands.}

github-actions · 2026-09-17T12:09:38Z

Visual recap — skipped

The visual recap job did not run for this pull request. This is informational only and does not block the PR.

Recap skipped for 664f2cf: bot author (type=Bot).

github-actions · 2026-09-17T12:09:38Z

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Snapshot Warnings

⚠️: No snapshots were found for the head SHA 369130d.

Ensure that dependencies are being submitted on PR branches and consider enabling retry-on-snapshot-warnings. See the documentation for more information and troubleshooting advice.

Scanned Files

None

abhimehro · 2026-09-17T12:09:40Z

✅ Snyk checks have passed. No issues have been found so far.

Status	Scan Engine	Critical	High	Medium	Low	Total (0)
✅	Open Source Security	0	0	0	0	0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

codacy-production · 2026-09-17T12:11:16Z

Not up to standards ⛔

🔴 Issues 6 minor

Alerts:
⚠ 6 issues (≤ 0 issues of at least minor severity)

Results:
6 new issues

Category Results

CodeStyle 6 minor

View in Codacy

AI Reviewer: first review requested successfully. AI can make mistakes. Always validate suggestions.

_{TIP This summary will be updated as you push new changes.}

Copilot

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

qodo-code-review · 2026-09-18T02:11:20Z

PR Summary by Qodo

Align repository guidance and bug reports with the uv CLI

📝 Documentation ✨ Enhancement 🕐 10-20 Minutes

AI Description

• Correct clone and uv-based run instructions for the supported setup.
• Document all CI checks and accurate folder configuration sources.
• Tailor bug reports to CLI diagnostics and credential-safe reproduction details.

Diagram

graph TD
  Contributor["Contributor"] --> Readme["README Quick Start"] --> CLI["uv CLI"]
  Contributor --> Warp["WARP Guidance"] --> Config["Config Sources"]
  Reporter["Bug Reporter"] --> Template["CLI Bug Template"] --> Issue["Actionable Report"]

High-Level Assessment

Directly correcting the existing README, WARP guide, and Markdown issue template is the lowest-risk approach. A migration to GitHub issue forms could enforce structured fields, but it would add configuration scope without improving the documentation corrections targeted by this PR.

Files changed (3) +35 / -34

Enhancement (1) +18 / -21

bug_report.mdReplace web-oriented prompts with CLI diagnostics +18/-21

Replace web-oriented prompts with CLI diagnostics

• Reworks the bug report template around exact uv commands, clean-clone reproduction steps, runtime versions, and observed output. Adds explicit instructions to redact Control D tokens and profile IDs.

.github/ISSUE_TEMPLATE/bug_report.md

Bug fix (1) +3 / -2

WARP.mdCorrect blocklist configuration guidance +3/-2

Correct blocklist configuration guidance

• Points built-in folder URL customization to config.py instead of main.py. Documents config.yaml and the --config option as the file-based configuration path.

WARP.md

Documentation (1) +14 / -11

README.mdCorrect setup commands and complete the CI workflow table +14/-11

Correct setup commands and complete the CI workflow table

• Updates the clone URL to the canonical repository and runs all documented commands through uv. Expands the CI table to include lint, type-checking, and performance workflows.

README.md

codacy-production

Pull Request Overview

This PR updates documentation and issue templates to align with the uv toolchain and current project standards. However, the analysis indicates that the PR is currently not up to standards, primarily due to multiple formatting violations in the README.

While the transition to uv run is correctly applied in most areas, it has introduced line-length issues (MD013) in the command examples. Additionally, the CI/CD workflow table requires more consistent terminology to match the rest of the documentation. Please verify that the bug report template and repository clone URL updates have been fully implemented as per the acceptance criteria.

About this PR

The documentation updates introduce several style violations, specifically line length exceeds in the README. These must be addressed to maintain the project's quality standards.

Test suggestions

Verify that all documented bash examples for running the script utilize the 'uv run' prefix
Validate that the Bug report template correctly prompts for CLI environment details (OS, Python, uv, version/commit)
Confirm the clone URL in the 'Clone & install' section matches the target repository 'abhimehro/ctrld-sync'

Prompt proposal for missing tests

Consider implementing these tests if applicable:
1. Verify that all documented bash examples for running the script utilize the 'uv run' prefix
2. Validate that the Bug report template correctly prompts for CLI environment details (OS, Python, uv, version/commit)
3. Confirm the clone URL in the 'Clone & install' section matches the target repository 'abhimehro/ctrld-sync'

_{TIP Improve review quality by adding custom instructions}
_{TIP How was this review? Give us feedback}

codacy-production · 2026-09-18T02:11:28Z

+   uv run python main.py --dry-run                          # plan only, no API calls
+   uv run python main.py --dry-run --plan-json plan.json    # machine-readable dry-run output
+   uv run python main.py --profiles your_id                 # live run (requires TOKEN)


_{⚪ LOW RISK}

Suggestion: Reduce the excessive padding between the command and its descriptive comment to fit within the 80-character limit.

This might be a simple fix:

Suggested change

uv run python main.py --dry-run # plan only, no API calls

uv run python main.py --dry-run --plan-json plan.json # machine-readable dry-run output

uv run python main.py --profiles your_id # live run (requires TOKEN)

uv run python main.py --dry-run # plan only, no API calls

uv run python main.py --dry-run --plan-json plan.json # JSON plan output

uv run python main.py --profiles your_id # live run (requires TOKEN)

codacy-production · 2026-09-18T02:11:28Z

-| **Test**   | `test.yml`   | Push/PR to `main`                   | Full pytest suite via `uv sync --all-extras`                                     |
+| Workflow        | File              | Trigger                             | Purpose                                                                          |
+| --------------- | ----------------- | ----------------------------------- | -------------------------------------------------------------------------------- |
+| **Sync**        | `sync.yml`        | Daily at 02:00 UTC, manual dispatch | Main synchronization workflow — runs `main.py` to keep Control D folders in sync |


_{⚪ LOW RISK}

Nitpick: To maintain consistency with the rest of the documentation and the 'Test' workflow description below, consider mentioning uv here.

Suggested change

| **Sync** | `sync.yml` | Daily at 02:00 UTC, manual dispatch | Main synchronization workflow — runs `main.py` to keep Control D folders in sync |

**Sync** | `sync.yml` | Daily at 02:00 UTC, manual dispatch | Main synchronization workflow — runs `main.py` via `uv` to keep Control D folders in sync |

qodo-code-review · 2026-09-18T02:11:29Z

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 🔗 Cross-repo conflicts (0) 📜 Skill insights (0)

No findings for this group

1. ~~The workflow table overstates checks~~ ✓ Resolved 🟠 Medium 🐞 Bug ≡ Correctness

Description

The new Performance row says performance.yml runs for every pull request to main, but that
workflow applies pull-request path filters. Pull requests that do not modify the four configured
code, benchmark, or workflow paths—such as this documentation-only PR—do not receive that check.

Code

README.md[306]

+| **Performance** | `performance.yml` | Push/PR to `main`                   | Performance regression checks                                                    |

Relevance

●●● Strong
Recent PRs accepted corrections to inaccurate README workflow descriptions and CI trigger
documentation.
PR-#1162
PR-#392
PR-#398

ⓘ Recommendations generated based on similar findings in past PRs

Evidence

The added README row advertises an unrestricted pull-request trigger, while the workflow's
pull_request.paths block restricts execution to changes in main.py, benchmark data, the workflow
itself, and designated performance tests.

README.md[306-306]
.github/workflows/performance.yml[3-10]

Agent prompt

The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
The CI workflow table says performance checks run for all pull requests to `main`, while the workflow limits pull-request execution to selected paths.

## Fix Focus Areas
- README.md[306-306]
- .github/workflows/performance.yml[3-10]

## Recommended Fix
Change the Performance trigger description to state that pushes to `main` run it, while pull requests run it only for performance-related paths.

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

No findings for this group

Context sources

✅ Compliance rules (platform): 11 rules

✅ Skills: testing-github-actions-workflows

✅ Cross-repo context — repo relationships

✅ REVIEW.md

Tip of the day

💡 Did you know, you can type 'qodo, fix this' on a finding and the fix lands right on your PR

More tips ↗ | Customize Qodo ↗ | Qodo docs ↗

qodo-code-review · 2026-09-18T02:13:05Z

Qodo Fixer

✅ Committed (1) · ☑ Fixed (1)

Commits pushed directly to this PR — no separate fix PR opened.

Process — 1 fixed

☑ Fixed: The workflow table overstates checks

…4aac

snyk-io · 2026-09-18T04:43:10Z

✅ Snyk checks have passed. No issues have been found so far.

Status	Scan Engine	Critical	High	Medium	Low	Total (0)
✅	Open Source Security	0	0	0	0	0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

codescene-access

No application code in the PR — skipped Code Health checks.

See analysis details in CodeScene

Quality Gate Profile: Clean Code Collective
Install CodeScene MCP: safeguard and uplift AI-generated code. Catch issues early with our IDE extension and CLI tool.

cursoragent and others added 2 commits September 17, 2026 12:09

github-actions Bot added documentation Improvements or additions to documentation configuration labels Sep 17, 2026

This comment was marked as outdated.

Sign in to view

cursor Bot requested a review from abhimehro September 17, 2026 12:19

abhimehro self-assigned this Sep 18, 2026

abhimehro marked this pull request as ready for review September 18, 2026 02:10

Copilot AI lite review requested due to automatic review settings September 18, 2026 02:10

Copilot AI reviewed Sep 18, 2026

qodo-code-review Bot added the 🕐 10-20 Minutes label Sep 18, 2026

qodo-code-review Bot added the 🟠 Medium blast radius label Sep 18, 2026

codacy-production Bot reviewed Sep 18, 2026

View reviewed changes

qodo-code-review Bot reviewed Sep 18, 2026

View reviewed changes

Comment thread README.md Outdated

fix: Document performance path filters

369130d

This comment was marked as outdated.

Sign in to view

Merge branch 'main' into cursor-agent/repository-health-housekeeping-…

664f2cf

…4aac

codescene-access Bot approved these changes Sep 18, 2026

View reviewed changes

abhimehro merged commit cf47067 into main Sep 18, 2026
17 of 19 checks passed

abhimehro deleted the cursor-agent/repository-health-housekeeping-4aac branch September 18, 2026 05:08

abhimehro mentioned this pull request Sep 18, 2026

docs(repo-health): fix clone URL and uv run quick start #1248

Closed

7 of 8 tasks

	\| Sync \| `sync.yml` \| Daily at 02:00 UTC, manual dispatch \| Main synchronization workflow — runs `main.py` to keep Control D folders in sync \|
	Sync \| `sync.yml` \| Daily at 02:00 UTC, manual dispatch \| Main synchronization workflow — runs `main.py` via `uv` to keep Control D folders in sync \|

Conversation

cursor Bot commented Sep 17, 2026

Submitting a Pull Request

Summary

Branch Naming

Before Opening a PR

PR Description

What Changed and Why

Security Implications

Secrets

Checklist

Uh oh!

trunk-io Bot commented Sep 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai Bot commented Sep 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Uh oh!

github-actions Bot commented Sep 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Visual recap — skipped

Uh oh!

github-actions Bot commented Sep 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Dependency Review

Snapshot Warnings

Scanned Files

Uh oh!

abhimehro commented Sep 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Snyk checks have passed. No issues have been found so far.

Uh oh!

This comment was marked as outdated.

Uh oh!

codacy-production Bot commented Sep 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Not up to standards ⛔

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

qodo-code-review Bot commented Sep 18, 2026

PR Summary by Qodo

Uh oh!

codacy-production Bot left a comment

Choose a reason for hiding this comment

Pull Request Overview

About this PR

Test suggestions

Uh oh!

codacy-production Bot Sep 18, 2026

Choose a reason for hiding this comment

Uh oh!

codacy-production Bot Sep 18, 2026

Choose a reason for hiding this comment

Uh oh!

qodo-code-review Bot commented Sep 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code Review by Qodo

Uh oh!

Uh oh!

qodo-code-review Bot commented Sep 18, 2026

Qodo Fixer

Uh oh!

This comment was marked as outdated.

Uh oh!

snyk-io Bot commented Sep 18, 2026

✅ Snyk checks have passed. No issues have been found so far.

Uh oh!

codescene-access Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

trunk-io Bot commented Sep 17, 2026 •

edited

Loading

coderabbitai Bot commented Sep 17, 2026 •

edited

Loading

github-actions Bot commented Sep 17, 2026 •

edited

Loading

github-actions Bot commented Sep 17, 2026 •

edited

Loading

abhimehro commented Sep 17, 2026 •

edited

Loading

codacy-production Bot commented Sep 17, 2026 •

edited

Loading

qodo-code-review Bot commented Sep 18, 2026 •

edited

Loading