chore: add AGENTS.md with project conventions and verification steps - #30
Merged
Conversation
Documents architecture, handler/env conventions, verification commands, and git/PR workflow so future agent sessions can ramp up quickly.
📝 WalkthroughWalkthroughAdds a new AGENTS.md file documenting repository guidance for AI agents, including project overview, architecture, environment-variable validation conventions, handler registration, error-handling expectations, verification steps, and Git/PR workflow practices. ChangesAGENTS.md Documentation
Estimated code review effort: 1 (Trivial) | ~2 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
codeant-ai
Bot
added
the
size:M
This comment has been minimized.
This comment has been minimized.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
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 `@AGENTS.md`:
- Around line 16-28: The architecture section uses a fenced code block without a
language tag, which trips markdownlint. Update the fenced block in AGENTS.md to
include a language identifier such as text while keeping the existing content
and formatting intact. Use the surrounding architecture listing to locate the
block and ensure all fenced blocks in that section are properly tagged.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
Comment on lines
+16
to
+28
| ``` | ||
| bot.js # Entry point: ensureEnvVars -> createClient -> register handlers -> login | ||
| webserver.js # Express issue intake server | ||
| src/ | ||
| client/ # Discord client setup (intents, partials) | ||
| commands/ # Slash command registration + command definitions | ||
| config/ # env.js (required-var validation), constants.js (role/config derivation) | ||
| handlers/ # Event-driven handlers registered via registerXxxHandlers(client) | ||
| interactions/ # Slash + button interaction logic | ||
| utils/ # Shared helpers (embeds) | ||
| web/ # Static issue/data report forms | ||
| test/ # Node --test files | ||
| ``` |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low value
Label the architecture fence.
This block should include a language tag (for example, text) to satisfy markdownlint and keep the docs build clean.
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 16-16: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for 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.
In `@AGENTS.md` around lines 16 - 28, The architecture section uses a fenced code
block without a language tag, which trips markdownlint. Update the fenced block
in AGENTS.md to include a language identifier such as text while keeping the
existing content and formatting intact. Use the surrounding architecture listing
to locate the block and ensure all fenced blocks in that section are properly
tagged.
Source: Linters/SAST tools
Nivmizz7
approved these changes
Jul 9, 2026
3 tasks
Member
Author
Member
|
LGTM |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
User description
Summary
AGENTS.mddocumenting the project architecture, handler/env conventions, verification commands, and git/PR workflow.Test plan
npm testpassesCodeAnt-AI Description
Add repository guidance for future contributors and AI agents
What Changed
Impact
✅ Easier onboarding for new contributors✅ Fewer missed setup steps✅ More consistent code changes and reviews💡 Usage Guide
Checking Your Pull Request
Every time you make a pull request, our system automatically looks through it. We check for security issues, mistakes in how you're setting up your infrastructure, and common code problems. We do this to make sure your changes are solid and won't cause any trouble later.
Talking to CodeAnt AI
Got a question or need a hand with something in your pull request? You can easily get in touch with CodeAnt AI right here. Just type the following in a comment on your pull request, and replace "Your question here" with whatever you want to ask:
This lets you have a chat with CodeAnt AI about your pull request, making it easier to understand and improve your code.
Example
Preserve Org Learnings with CodeAnt
You can record team preferences so CodeAnt AI applies them in future reviews. Reply directly to the specific CodeAnt AI suggestion (in the same thread) and replace "Your feedback here" with your input:
This helps CodeAnt AI learn and adapt to your team's coding style and standards.
Example
Retrigger review
Ask CodeAnt AI to review the PR again, by typing:
Check Your Repository Health
To analyze the health of your code repository, visit our dashboard at https://app.codeant.ai. This tool helps you identify potential issues and areas for improvement in your codebase, ensuring your repository maintains high standards of code health.