Update AGENTS.md with squash fix commits requirement

[alltheseas]

added

"squash self-referential fix/refactor commits"

Summary by CodeRabbit

• Documentation
  • Rewrote and condensed agent guidelines into a tighter sequence, emphasizing standalone commit scaffolding, readability/reviewability, profiling and performance, and expanded housekeeping (docstrings, formatting, tests). Clarified constraints and workflow guidance around global state, nesting, CI fidelity, vendoring, concurrency patterns, UI/frame rules, cherry-picking, and frame-aware animations. Concluding launchpad guidance retained.

[alltheseas]

@kernelkind adding to AGENTS.md per your feedback

[coderabbitai]

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

• @coderabbitai resume to resume automatic reviews.
• @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

• ▶️ Resume reviews
• 🔍 Trigger review

📝 Walkthrough

Walkthrough

Rewrote the Notedeck agent guidelines in AGENTS.md: removed previous items 3–22 and replaced them with a reorganized, condensed list (new items 3–18) covering commit scaffolding, readability/docstrings, Puffin profiling and performance attributes, concurrency/UI constraints, vendoring, testing/formatting, and workflow notes.

Changes

Cohort / File(s)

Summary

Documentation — AGENTS.md AGENTS.md

Replaced items 3–22 with a condensed, reordered set (new items 3–18). Adds guidance on standalone commits, readability and docstrings, Puffin profiling and performance attributes, global-state and concurrency constraints, CI fidelity, vendoring/dependency rules, formatting/tests, UI/frame and animation constraints, and workflow (cherry-picking/rebasing). Review attention: concurrency/UI constraints, profiling mentions, and workflow/commit guidance.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐇 I nibble through guidelines, tidy each line,
I hop, profile, and shape commits to shine.
Docs that sing and frames that softly glide,
No tangled state — I keep the path wide.
A carrot-marked note, a tidy stride.

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The PR title 'Update AGENTS.md with squash fix commits requirement' is partially related to the changeset. While it mentions the squash fix commits guidance, the summary indicates the PR also adds three additional rubric items (19–21) about code duplication and simplicity, which are not referenced in the title.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[kernelkind]

good idea. I'm uncertain whether the AI will understand the meaning though. I'm more inclined to something like:
"commits which have code which contain fixes or refactors which were introduced in the same PR should be rebased such that the fixes are added to the original code history"

[alltheseas]

Also updated with

19. **Verify that existing code that can do the job is not ignored** (in lieu of creating code that performs the same function of existing code).
20. **Do not accrue duplicate code.** Always revisit how existing code can be applied and/or refactored in solving new issues.
21. **Value simplicity** One line of code is better than ten. Ten is better than a hundred. A commit with ten thousand lines of code is not reviewable by a human developer.

[alltheseas]

@kernelkind

fixed in

539b8d2

good idea. I'm uncertain whether the AI will understand the meaning though. I'm more inclined to something like:
"commits which have code which contain fixes or refactors which were introduced in the same PR should be rebased such that the fixes are added to the original code history"

[coderabbitai]

Actionable comments posted: 2

🤖 Fix all issues with AI agents

In `@AGENTS.md`:
- Line 109: The phrase "code to be human readable, and reviewable by human
developers" in AGENTS.md should be hyphenated for clarity; change it to "code to
be human-readable, and reviewable by human developers" by inserting a hyphen
between "human" and "readable" in that sentence.
- Around line 111-115: Remove the phrase "in order to" from the two sentences
that contain it: the end of item 6 ("...in order to see functions performance in
the profiler") should be changed to "...to see function performance in the
profiler" (also consider singular "function"), and the end of item 10 ("in order
to get a commit or PR to pass") should be changed to "to get a commit or PR to
pass"; update those two lines in AGENTS.md accordingly and ensure
spacing/grammar remains correct.

[coderabbitai]

Actionable comments posted: 2

🤖 Fix all issues with AI agents

In `@AGENTS.md`:
- Line 109: The sentence in AGENTS.md containing "Related to logically distinct
code, and standalone commits care must be taken for all **code to be
human-readable, and reviewable by human developers**." has awkward structure;
fix by inserting a comma after "commits" or rephrasing to "Related to logically
distinct code and standalone commits, care must be taken..." so the subject-verb
agreement and readability are correct—locate the clause containing "standalone
commits" and adjust punctuation/word order accordingly.
- Line 127: The sentence "Always prefer simplicity One line of code..." is a
run-on; insert punctuation after the phrase "Always prefer simplicity" (for
example a period, colon, or em-dash) to separate it from the following sentence
fragment so it reads correctly (e.g., "Always prefer simplicity. One line of
code is better than ten."). Update the AGENTS.md sentence containing "Always
prefer simplicity" accordingly.

🧹 Nitpick comments (2)

AGENTS.md (2)

124-124: Consider simplifying the phrasing.

The phrase "Commits which have code which contain" is verbose. Streamlining to "Commits containing" would improve readability while preserving the reviewer's intended meaning.

✏️ Suggested edit

-19. Commits which have code which contain fixes or refactors which were introduced in the same PR should be **rebased such that the fixes are added to the original code history**.
+19. Commits containing fixes or refactors introduced in the same PR should be **rebased such that the fixes are added to the original code history**.

---

125-126: Tighten phrasing for clarity.

Both items contain minor wordiness:

• Line 125: The parenthetical explanation is redundant—the bold text already conveys the point.
• Line 126: "in solving" should be "when solving" or "to solve" for better grammar.

✏️ Suggested edits

-20. **Verify that existing code that can do the job is not ignored** (in lieu of creating code that performs the same function of existing code).
+20. **Verify that existing code that can do the job is not ignored.**

-21. **Do not accrue duplicate code.** Always revisit how existing code can be applied and/or refactored in solving new issues.
+21. **Do not accrue duplicate code.** Always revisit how existing code can be applied and/or refactored when solving new issues.

Based on learnings, these items correctly emphasize inspecting Notedeck code for reusable components before creating new code.

[alltheseas]

@kernelkind @jb55 I updated this one after asking the agent to come up with instructions that have a lower chance of being ignored