docs: Add AGENTS.md for AI coding agent guidance#5541
Open
morozow wants to merge 1 commit intokirodotdev:mainfrom
Open
Conversation
- Add AGENTS.md with detailed agent scope, identity, and primary goals - Document project overview including purpose, core domains, and critical invariants - Include environment setup requirements (Node.js 20.x, TypeScript 5.3.3, npm) - Provide complete repository structure map and architecture overview - List all key entrypoints for automation scripts and GitHub Actions workflows - Define coding conventions including TypeScript strict mode, ES modules, and import patterns - Establish testing strategy with unit and integration test patterns - Document workflow rules for branching, commits, and pull requests - Specify safety requirements for secrets, environment variables, and destructive operations - Include security requirements for input sanitization and prompt injection detection - Document AWS Bedrock integration details and GitHub API requirements - Provide reference commands for building, testing, and local development
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
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.
Issue #, if available: ––
Description of changes:
AGENTS.md for AI coding agent guidance
This PR adds an
AGENTS.mdfile to provide structured guidance for AI coding agents working in this repository.What is AGENTS.md?
AGENTS.md is a simple, open format for guiding coding agents, used by over 60k open-source projects. It serves as a "README for agents" — a dedicated, predictable place to provide context and instructions that help AI coding agents work effectively on your project.
AGENTS.md is now stewarded by the Agentic AI Foundation under the Linux Foundation.
Why AGENTS.md?
What this PR adds
The
AGENTS.mdfile includes:How to test
References
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.