Skip to content

Commit ff66c1c

Browse files
authored
Add .cursorrules link and include more in REVIEW.md about commit series (#176)
* common: Add .cursorrules symlink pointing to AGENTS.md Cursor reads .cursorrules as its agent instruction file. Symlinking it to AGENTS.md keeps a single source of truth rather than maintaining separate files that can drift. Assisted-by: OpenCode (claude-sonnet-4-6@default) Signed-off-by: Colin Walters <walters@verbum.org> * REVIEW: Clarify that review feedback should be squashed, not a new commit A recurring pattern, especially with AI-assisted reviews (Gemini, Copilot, etc.), is that applying a suggested fix creates a new commit with a generic auto-generated subject like "Update README.md". That commit should be squashed into the original before merge. Motivated by bootc-dev/bootc#2182. Assisted-by: OpenCode (claude-sonnet-4-6@default) Signed-off-by: Colin Walters <walters@verbum.org> --------- Signed-off-by: Colin Walters <walters@verbum.org>
1 parent 7499375 commit ff66c1c

2 files changed

Lines changed: 15 additions & 0 deletions

File tree

common/.cursorrules

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
AGENTS.md

common/REVIEW.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,20 @@ Generally, just restate the commit message.
139139

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

142+
### Further changes on top of existing commits
143+
144+
If you have followup fixes (whether that's part of a local loop or
145+
as part of addressing PR review), it is generally encouraged to *squash*
146+
the fixes into the prior commit. Do not create generically-named "Update <file>" commits
147+
or "Address review feedback" or "Fix cargo fmt" commits.
148+
149+
This applies equally when an AI tool (e.g. Gemini, Copilot) suggests a
150+
change via a review comment — applying the suggestion creates a new commit
151+
with an auto-generated subject. That commit should be squashed before the
152+
PR is merged.
153+
154+
In other words either a commit "stands alone" with its own rationale or it doesn't.
155+
142156
### Keeping PRs Current
143157

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

0 commit comments

Comments
 (0)