Skip to content

docs: restore coding pattern guidance - #120

Merged
siyul-park merged 15 commits into
mainfrom
feature/restore-coding-patterns
Jul 6, 2026
Merged

docs: restore coding pattern guidance#120
siyul-park merged 15 commits into
mainfrom
feature/restore-coding-patterns

Conversation

@siyul-park

@siyul-park siyul-park commented Jul 6, 2026 •
edited
Loading

Copy link
Copy Markdown
Owner

Changes Made

  • Condensed docs/coding-patterns.md while preserving restored coding-style guidance.
  • Kept the core rules for simplicity, symbol review, algorithm review, repeated simplification passes, naming, file layout, APIs, errors, tests, PRs, and docs.
  • Updated AGENTS.md to route agent workflow, coding expectations, tests, and documentation maintenance to specific docs/coding-patterns.md sections.
  • Updated .claude/CLAUDE.md to use docs/coding-patterns.md as the authority and keep Claude-specific pre-finish checks section-based.

Related Issues

  • None.

Additional Information

  • Documentation-only change.
  • Validation: reviewed the updated Markdown structure and confirmed the PR changes only documentation files.

@coderabbitai

coderabbitai Bot commented Jul 6, 2026 •
edited
Loading

Copy link
Copy Markdown

Review Change Stack

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

This PR restructures docs/coding-patterns.md, updates .claude/CLAUDE.md to require and explain its use, and revises AGENTS.md to align workflow, reference, and documentation guidance with the new coding-patterns rules.

Changes

Coding patterns and agent workflow

Layer / File(s) Summary
Coding patterns sections and end matter
docs/coding-patterns.md		 Adds upfront usage guidance, reorganizes the principles and numbered conventions, and expands the documentation-update rule, maintenance notes, and related links.
Agent workflow and reference updates
AGENTS.md		 Updates the workflow read steps, documentation index entry, diagram formatting, invariant wording, executable buffer sequence, and the rewritten coding expectations guidance.

Claude workflow guidance

Layer / File(s) Summary
Claude reading and review rules
.claude/CLAUDE.md		 Strengthens the required docs-read step, adds usage instructions for coding patterns, rewrites style conventions, and expands the self-review checklist.

Estimated code review effort: 2 (Simple) | ~10 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title clearly matches the main documentation-focused change set and is specific enough for history scanning.
Description check ✅ Passed All required sections are present and the key documentation-only changes are described clearly.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feature/restore-coding-patterns

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

coderabbitai[bot]
coderabbitai Bot reviewed Jul 6, 2026
View reviewed changes

@coderabbitai coderabbitai 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.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/coding-patterns.md`:
- Around line 471-480: The documentation matrix in docs/coding-patterns.md is
too permissive for invariant/pitfall changes because it uses an “or” between
workflow docs, allowing one of AGENTS.md or CLAUDE.md to remain outdated. Update
the relevant table entry and surrounding guidance so invariant/pitfall changes
require both workflow docs to be kept in sync, and make sure the wording in
docs/coding-patterns.md matches the repo contract for convention-changing
updates.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 51363b1f-929f-460c-9939-4337e4841771

📥 Commits

Reviewing files that changed from the base of the PR and between 2295478 and cbcf00c.

📒 Files selected for processing (1)
  • docs/coding-patterns.md

Comment thread docs/coding-patterns.md
@siyul-park
siyul-park merged commit c84dd91 into main Jul 6, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@siyul-park