Skip to content

Add ai-coding-guide to Directories#215

Open
jnMetaCode wants to merge 2 commits intoPatrickJS:mainfrom
jnMetaCode:add-ai-coding-guide
Open

Add ai-coding-guide to Directories#215
jnMetaCode wants to merge 2 commits intoPatrickJS:mainfrom
jnMetaCode:add-ai-coding-guide

Conversation

@jnMetaCode
Copy link
Copy Markdown

@jnMetaCode jnMetaCode commented Mar 27, 2026

What

Add ai-coding-guide to the Directories section.

Why

A Chinese-language best practices guide covering 8 AI coding tools — including Cursor — with copy-paste config templates (.cursorrules, .windsurfrules, CLAUDE.md, etc.) and multi-tool collaboration workflows.

Covers: Claude Code, Cursor, Copilot, Windsurf, Gemini CLI, Kiro, Aider, Trae.

Summary by CodeRabbit

  • Documentation
    • Added an "ai-coding-guide" directory listing that documents best practices for 9 AI coding tools and includes copy-paste configuration templates for quick setup.
    • Reordered the directories list: moved the "CursorList" entry from the top to the bottom.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 27, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: e9952ab3-14e9-44dc-b1aa-45fa9e76120d

📥 Commits

Reviewing files that changed from the base of the PR and between 9ec2658 and 2dd9158.

📒 Files selected for processing (1)
  • README.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • README.md

📝 Walkthrough

Walkthrough

README.md updated: the CursorList entry in the "Directories" list was moved from the top to the bottom, and a new ai-coding-guide directory link was added with a description referencing best practices and copy-paste configuration templates for 9 AI coding tools. No code or exports changed. (+2/−1)

Changes

Cohort / File(s) Summary
Documentation
README.md
Moved CursorList entry within the "Directories" list and added a new ai-coding-guide directory link describing best practices and copy-paste configuration templates for 9 AI coding tools. Lines changed: +2 / -1.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A new guide sprouts beneath the log,
Nine tools lined up in the coding bog.
Copy, paste, and follow along,
The warren hums a helpful song,
Hoppity-hop — documentation strong!

🚥 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 title 'Add ai-coding-guide to Directories' accurately and concisely describes the main change: adding a new directory entry to the Directories section.
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

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 and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

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 the current code and only fix it if needed.

Inline comments:
In `@README.md`:
- Around line 292-294: The "Directories" list in README.md is out of
alphabetical order; move the "CursorDirectory" entry so it appears before
"CursorList" (i.e., reorder the three lines so "CursorDirectory" precedes
"CursorList"), and then scan the rest of the "Directories" section to ensure all
entries are alphabetically sorted; update any adjacent ordering if necessary.
🪄 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

Run ID: c75fff82-b985-4cea-ad84-a2df4711091c

📥 Commits

Reviewing files that changed from the base of the PR and between fc2ce04 and 9ec2658.

📒 Files selected for processing (1)
  • README.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant