Add AGENTS.md #374
Add AGENTS.md #374
Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive repository guidelines for both human contributors and AI assistants by introducing AGENTS.md, updates the RAG example to maintained status with proper CI/CD badge integration, and enhances the contributing guide with more detailed coding conventions and standardized command patterns.
- Introduces
AGENTS.mdwith detailed guidelines covering architecture, project structure, coding style, testing, and contribution workflows - Promotes RAG example from unmaintained to maintained status with full badge workflow integration
- Standardizes development commands with
--no-syncflag and updates formatting/testing instructions in contributing.md
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| AGENTS.md | New repository guidelines document covering architecture, coding standards, testing practices, and contribution workflows |
| CLAUDE.md | Pointer file referencing AGENTS.md, likely for AI assistant configuration |
| examples/rag/README.md | Adds workflow status badge for RAG example |
| examples/README.md | Updates RAG example from unmaintained to maintained status with badge integration; adjusts search_r1 status description |
| docs/community/contributing.md | Enhances with detailed coding conventions, standardizes commands with --no-sync flag, and improves formatting instructions |
| .github/workflows/badge-rag.yml | New workflow for generating RAG example status badge |
| .github/workflows/badge-latest.yml | Registers RAG and Claude Code examples for latest version badge tracking |
| .github/workflows/badge-examples.yml | Adds RAG example to stable version badge aggregation |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
AGENTS.md
Outdated
| Always commit the refreshed `uv.lock` when dependencies shift, and mention optional groups (VERL, APO, GPU) in PR notes. | ||
|
|
||
| ## Coding Style & Naming Conventions | ||
| - Target `requires-python >= 3.10`, four-space indentation, 120-character lines (restriction can be relaxed for docstrings), and formatter-owned diffs (Black + isort, `black` profile). Use `snake_case` for modules, functions, and variables; `PascalCase` for classes and React components; lowercase hyphenation for CLI flags, branch names, and TypeScript filenames. |
There was a problem hiding this comment.
[nitpick] The character count for "120-character lines" appears inconsistent with the actual limit. The text mentions "120-character lines" in one place and "120-character lines" in another, but based on common practice and the "" (approximately) symbol used in line 171, this should be consistent. Consider using "~120-character" in both places for clarity, since docstrings are explicitly allowed to exceed this limit.
| - Target `requires-python >= 3.10`, four-space indentation, 120-character lines (restriction can be relaxed for docstrings), and formatter-owned diffs (Black + isort, `black` profile). Use `snake_case` for modules, functions, and variables; `PascalCase` for classes and React components; lowercase hyphenation for CLI flags, branch names, and TypeScript filenames. | |
| - Target `requires-python >= 3.10`, four-space indentation, ~120-character lines (restriction can be relaxed for docstrings), and formatter-owned diffs (Black + isort, `black` profile). Use `snake_case` for modules, functions, and variables; `PascalCase` for classes and React components; lowercase hyphenation for CLI flags, branch names, and TypeScript filenames. |
AGENTS.md
Outdated
| Always commit the refreshed `uv.lock` when dependencies shift, and mention optional groups (VERL, APO, GPU) in PR notes. | ||
|
|
||
| ## Coding Style & Naming Conventions | ||
| - Target `requires-python >= 3.10`, four-space indentation, 120-character lines (restriction can be relaxed for docstrings), and formatter-owned diffs (Black + isort, `black` profile). Use `snake_case` for modules, functions, and variables; `PascalCase` for classes and React components; lowercase hyphenation for CLI flags, branch names, and TypeScript filenames. |
There was a problem hiding this comment.
[nitpick] The phrase "restriction can be relaxed" is awkward. Consider rephrasing to "though docstrings may run longer" for better readability and consistency with the phrasing in contributing.md line 171.
| - Target `requires-python >= 3.10`, four-space indentation, 120-character lines (restriction can be relaxed for docstrings), and formatter-owned diffs (Black + isort, `black` profile). Use `snake_case` for modules, functions, and variables; `PascalCase` for classes and React components; lowercase hyphenation for CLI flags, branch names, and TypeScript filenames. | |
| - Target `requires-python >= 3.10`, four-space indentation, 120-character lines (though docstrings may run longer), and formatter-owned diffs (Black + isort, `black` profile). Use `snake_case` for modules, functions, and variables; `PascalCase` for classes and React components; lowercase hyphenation for CLI flags, branch names, and TypeScript filenames. |
| @@ -0,0 +1 @@ | |||
| AGENTS.md No newline at end of file | |||
There was a problem hiding this comment.
This file contains only the text "AGENTS.md" which appears to be a reference or pointer to the AGENTS.md file. The purpose of CLAUDE.md is unclear. If this is meant to indicate which file AI assistants (like Claude) should read for guidelines, consider adding a comment or brief explanation. Otherwise, this may be confusing to contributors.
No description provided.