docs: add AI coding assistant guidelines#1315
docs: add AI coding assistant guidelines#1315OreoYang wants to merge 2 commits intoIvorySQL:masterfrom
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
✅ Files skipped from review due to trivial changes (2)
📝 WalkthroughWalkthroughAdded documentation requiring AI/LLM-powered coding assistants to follow new contributor guidelines; updated English and Chinese READMEs to reference the new guidelines and added Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (3)
README_CN.md (1)
47-52: LGTM! Chinese section is consistent with English version.The Chinese AI assistant section properly mirrors the English version with appropriate translation and maintains the same strong directive tone. Both versions correctly link to the same
coding-assistants.mdfile.Optional: Consider adding a Chinese version of the guidelines.
While linking to the English
coding-assistants.mdis acceptable for AI tools, Chinese-speaking contributors using AI assistants might benefit from a Chinese translation (coding-assistants_CN.md). This would maintain consistency with the bilingual README structure.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README_CN.md` around lines 47 - 52, Reviewer suggests adding a Chinese translation of the AI assistant guidelines; create a new file named coding-assistants_CN.md containing a faithful Chinese translation of coding-assistants.md, then update README_CN.md to link to coding-assistants_CN.md (keep the existing English link if desired for fallback). Locate references in README_CN.md and ensure the new file mirrors sections, headings, and licensing/attribution language from coding-assistants.md and is encoded/formatted consistently.coding-assistants.md (2)
8-8: Consider adding a link to PostgreSQL coding conventions.While the reference to "PostgreSQL coding conventions" is appropriate, providing a specific link would help AI tools and developers locate the conventions more easily.
📚 Suggested addition
- `CONTRIBUTING.md` - Contribution guidelines and workflow -- PostgreSQL coding conventions +- [PostgreSQL coding conventions](https://www.postgresql.org/docs/current/source.html) - Existing IvorySQL code patterns and architecture🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@coding-assistants.md` at line 8, Replace the plain text "PostgreSQL coding conventions" with a clickable link pointing to the official or project's agreed-upon style guide (for example the PostgreSQL documentation or a specific internal URL); update the literal string in the file content where "PostgreSQL coding conventions" appears so it becomes a hyperlink and optionally add a short parenthetical describing which conventions the link covers (naming, formatting, SQL style).
35-54: Consider adding guidance on trailer placement in commit messages.The
Assisted-bytag format is clear, but the documentation doesn't specify where this trailer should appear in commit messages. Git trailers are conventionally placed at the end of the commit message body, separated by a blank line.📝 Suggested addition
After line 41, add placement guidance:
Assisted-by: AGENT_NAME:MODEL_VERSION+This tag should be placed at the end of the commit message, following Git trailer conventions:
+
++Short commit message summary + +Detailed description of the changes made... + +Assisted-by: AGENT_NAME:MODEL_VERSION +
+
Where:</details> <details> <summary>🤖 Prompt for AI Agents</summary>Verify each finding against the current code and only fix it if needed.
In
@coding-assistants.mdaround lines 35 - 54, Add guidance to the "##
Attribution" section to specify trailer placement for the Assisted-by tag: state
that the Assisted-by: AGENT_NAME:MODEL_VERSION trailer must be placed at the end
of the commit message body following a blank line (per Git trailer conventions)
and include a short example showing a summary, blank line, detailed description,
blank line, then Assisted-by: AGENT_NAME:MODEL_VERSION; update the text that
currently defines the tag format (the Assisted-by examples) to include this
placement guidance and the example commit message.</details> </blockquote></details> </blockquote></details> <details> <summary>🤖 Prompt for all review comments with AI agents</summary>Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In@coding-assistants.md:
- Line 8: Replace the plain text "PostgreSQL coding conventions" with a
clickable link pointing to the official or project's agreed-upon style guide
(for example the PostgreSQL documentation or a specific internal URL); update
the literal string in the file content where "PostgreSQL coding conventions"
appears so it becomes a hyperlink and optionally add a short parenthetical
describing which conventions the link covers (naming, formatting, SQL style).- Around line 35-54: Add guidance to the "## Attribution" section to specify
trailer placement for the Assisted-by tag: state that the Assisted-by:
AGENT_NAME:MODEL_VERSION trailer must be placed at the end of the commit message
body following a blank line (per Git trailer conventions) and include a short
example showing a summary, blank line, detailed description, blank line, then
Assisted-by: AGENT_NAME:MODEL_VERSION; update the text that currently defines
the tag format (the Assisted-by examples) to include this placement guidance and
the example commit message.In
@README_CN.md:
- Around line 47-52: Reviewer suggests adding a Chinese translation of the AI
assistant guidelines; create a new file named coding-assistants_CN.md containing
a faithful Chinese translation of coding-assistants.md, then update README_CN.md
to link to coding-assistants_CN.md (keep the existing English link if desired
for fallback). Locate references in README_CN.md and ensure the new file mirrors
sections, headings, and licensing/attribution language from coding-assistants.md
and is encoded/formatted consistently.</details> --- <details> <summary>ℹ️ Review info</summary> <details> <summary>⚙️ Run configuration</summary> **Configuration used**: Path: .coderabbit.yaml **Review profile**: CHILL **Plan**: Pro **Run ID**: `a900af86-c781-44a3-91d0-cec29224f991` </details> <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between 37c23940aeb7e58d686d2b34964e11442dcdb569 and 681f8adfbde997c0d4ba55d43cd5ad42f296610b. </details> <details> <summary>📒 Files selected for processing (3)</summary> * `README.md` * `README_CN.md` * `coding-assistants.md` </details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
3 participants
refer:
https://github.com/torvalds/linux/blob/master/README
https://github.com/torvalds/linux/blob/master/Documentation/process/coding-assistants.rst
Summary by CodeRabbit