Add AGENTS.md with AI coding agent guidelines#4102
Conversation
|
Important Review skippedBot user detected. To trigger a single review, invoke the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
📝 WalkthroughWalkthroughThis PR introduces two documentation updates: a new AGENTS.md file with guidelines for commit messages, code formatting, dependency management, OpenAPI spec regeneration, and localization; and an expanded TypeScript style guide with a new "Component Props" section prescribing alphabetized prop ordering. Changes
Possibly related issues
Poem
Estimated code review effort: 🎯 2 (Simple) | ⏱️ ~10 minutes 🚥 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)
Tip 💬 Introducing Slack Agent: The best way for teams to turn conversations into code.Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.
Built for teams:
One agent for your entire SDLC. Right inside Slack. 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 |
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as outdated.
This comment was marked as outdated.
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive documentation for AI coding agents working on The Combine codebase. It creates a new AGENTS.md file with structured guidelines and updates the TypeScript style guide to include component props alphabetization conventions.
Changes:
- Added
AGENTS.mdwith workflow requirements covering commit messages, code style, formatting, dependency management, OpenAPI generation, and localization - Enhanced
docs/style_guide/ts_style_guide.mdwith a new "Component Props" subsection documenting the convention to alphabetize React component props
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| AGENTS.md | New comprehensive guide for AI coding agents with workflow requirements, formatting conventions, and integration points including gitlint compliance, style guide references, npm scripts usage, and OpenAPI/localization workflows |
| docs/style_guide/ts_style_guide.md | Added "Component Props" subsection to the table of contents and documented alphabetization convention for React component props with examples and rationale |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #4102 +/- ##
=======================================
Coverage 75.94% 75.94%
=======================================
Files 303 303
Lines 11352 11352
Branches 1403 1403
=======================================
Hits 8621 8621
Misses 2330 2330
Partials 401 401
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Co-authored-by: imnasnainaec <6411521+imnasnainaec@users.noreply.github.com>
Co-authored-by: imnasnainaec <6411521+imnasnainaec@users.noreply.github.com>
Co-authored-by: imnasnainaec <6411521+imnasnainaec@users.noreply.github.com>
cb053f7 to
ecdcd05
Compare
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as outdated.
This comment was marked as outdated.
|
I think pulling this up one level for this and the Backend folder is a good idea. |
|
Pull this out to avoid a maintenance consistency issue in the future. |
jasonleenaylor
left a comment
There was a problem hiding this comment.
@jasonleenaylor reviewed 10 files and all commit messages, and made 1 comment.
Reviewable status: all files reviewed, 1 unresolved discussion (waiting on imnasnainaec).
Devin: https://app.devin.ai/review/sillsdev/TheCombine/pull/4102
Provides structured guidelines for AI coding agents working on The Combine codebase, covering workflow requirements, formatting conventions, and integration points.
Original prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.
This change is
Summary by CodeRabbit