AGENTS.md: add comprehensive guide for AI assistants#21163
AGENTS.md: add comprehensive guide for AI assistants#21163FazleArefin wants to merge 6 commits intotldr-pages:mainfrom
Conversation
Add a generic skills file to help AI assistants (Claude Code, opencode, etc.) understand and work with the tldr-pages repository effectively. The guide includes: - Project overview and structure - Page format specification and style guidelines - Platform directory rules and placeholder conventions - Testing and linting procedures - Language-specific translation rules - Quick reference templates - Common tasks for AI assistants This makes the repository more accessible to contributors using AI coding assistants.
The industry standard for this file is AGENTS.md
|
After evaluation, I renamed
Ref: Docs on AGENTS.md. |
|
@kbdharun Wondering if you had a chance to look into this. The |
Description
This PR adds a generic
AGENTS.mdfile to help AI coding assistants (Claude Code, GitHub Copilot, etc.) contribute effectively to tldr-pages.Why this helps the project
Reduces review burden: AI assistants with access to our style guidelines will create PRs that require fewer corrections, saving maintainer time.
Improves contribution quality: New contributors using AI tools will get accurate, context-aware guidance specific to our format.
Assists PR reviewers: Maintainers and reviewers can use AI assistants with this guide to automatically verify PRs against project standards—checking format compliance, placeholder syntax, imperative mood usage, and platform directory rules—making reviews faster and more consistent.
Complements existing docs: This doesn't duplicate
CONTRIBUTING.mdor the style guide—it's a condensed reference optimized for quick parsing by AI assistants, with practical templates and examples.What's included
Why a separate file?
AGENTS.mdautomaticallyTesting
This makes the repository more accessible to the growing number of contributors using AI coding assistants while maintaining our quality standards.
Checklist
tldr-lint(if applicable)