AGENTS.md: add comprehensive guide for AI assistants#21163
Open
FazleArefin wants to merge 6 commits intotldr-pages:mainfrom
Open
AGENTS.md: add comprehensive guide for AI assistants#21163FazleArefin wants to merge 6 commits intotldr-pages:mainfrom
FazleArefin 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.
dmmqz
reviewed
Feb 17, 2026
The industry standard for this file is AGENTS.md
Member
Author
|
After evaluation, I renamed
|
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.
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)