Skip to content

Add .cursorrules link and include more in REVIEW.md about commit series #176

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
cgwalters wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add .cursorrules link and include more in REVIEW.md about commit series #176

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
324d35f
common: Add .cursorrules symlink pointing to AGENTS.md
cgwalters May 1, 2026
bad7483
REVIEW: Clarify that review feedback should be squashed, not a new co…
cgwalters May 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions common/.cursorrules
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
AGENTS.md
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot May 1, 2026

Choose a reason for hiding this comment

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

medium

The symlink target AGENTS.md appears to be incorrect for a file located in the common/ subdirectory. Since the target AGENTS.md is at the repository root, the relative path should be ../AGENTS.md. As currently defined, this symlink is broken within this repository. Additionally, for the Cursor IDE to automatically discover these rules, the .cursorrules file typically needs to be located at the repository root rather than in a subdirectory.

../AGENTS.md

14 changes: 14 additions & 0 deletions common/REVIEW.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,20 @@ Generally, just restate the commit message.

Where it makes sense, it is OK to include additional details though.

### Further changes on top of existing commits

If you have followup fixes (whether that's part of a local loop or
as part of addressing PR review), it is generally encouraged to *squash*
the fixes into the prior commit. Do not create generically-named "Update <file>" commits
or "Address review feedback" or "Fix cargo fmt" commits.

This applies equally when an AI tool (e.g. Gemini, Copilot) suggests a
change via a review comment — applying the suggestion creates a new commit
with an auto-generated subject. That commit should be squashed before the
PR is merged.

In other words either a commit "stands alone" with its own rationale or it doesn't.

### Keeping PRs Current

Keep PRs rebased on main. When CI failures are fixed in other PRs, rebase to
Expand Down