docs: add AI development guidelines for contributors#60
Merged
Conversation
criskell
approved these changes
Apr 4, 2026
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.
Summary
Add project-level AI development guidelines so that any contributor using AI coding tools (Copilot, Cursor, Claude Code, Windsurf, Codex, etc.) follows the same conventions.
Three files were created:
AGENTS.md- Universal standard (supported by Cursor, Copilot, Windsurf, Codex, Devin and others)CLAUDE.md- Claude Code specific, references AGENTS.md to avoid duplication.github/copilot-instructions.md- GitHub Copilot specificContext
AI coding tools are widely adopted and each reads project rules from different files. Without explicit guidelines, contributors using these tools may generate code that doesn't follow our conventions (react-hook-form, i18n, Service Layer pattern, etc.), leading to PR rejections.
The
AGENTS.mdformat was chosen as the source of truth because it's an open standard maintained by the Linux Foundation (Agentic AI Foundation), supported natively by 10+ tools.CLAUDE.mdimports it via@AGENTS.mdto avoid content duplication.References used:
Questions or suggestions? Join us on Discord.