Conversation
Agent-Logs-Url: https://github.com/Ven0m0/Scripts/sessions/8faee965-db36-4c34-b3e6-9aadbeb16f1f Co-authored-by: Ven0m0 <82972344+Ven0m0@users.noreply.github.com>
Code Review SummaryStatus: No Issues Found | Recommendation: Merge This PR is a documentation consolidation effort with no code changes. It simplifies AI agent guidance files:
No security concerns, runtime errors, or logic issues - these are purely documentation/text file changes. Files Reviewed (2 files)
Reviewed by minimax-m2.5-20260211 · 90,701 tokens |
There was a problem hiding this comment.
Pull request overview
This PR consolidates the repository’s AI/agent guidance by making AGENTS.md the single canonical source, and trimming .github/copilot-instructions.md down to a brief Copilot entrypoint that links back to AGENTS.md.
Changes:
- Replaced the previous long-form
AGENTS.mdwith a concise, durable “source of truth” focused on repo map, v1/v2 boundaries, shared-library cautions, formatting, and CI references. - Reduced
.github/copilot-instructions.mdto a compact operating summary that referencesAGENTS.mdinstead of duplicating it.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| AGENTS.md | Consolidates canonical AI guidance (repo map, core rules, AHK guidance, validation references). |
| .github/copilot-instructions.md | Becomes a short Copilot entrypoint linking back to AGENTS.md and key repo validation references. |
| 4. **Respect Windows-oriented formatting rules.** | ||
| - `.ahk`, `.ps1`, `.cmd`, `.bat`: CRLF, UTF-8, 4 spaces | ||
| - `.md`, `.json`, `.yml`, `.yaml`: LF | ||
| - Follow `.editorconfig` and `.gitattributes` when they differ from editor defaults. |
There was a problem hiding this comment.
The line-ending guidance is internally inconsistent with the repo’s actual config: .gitattributes enforces *.md as eol=lf, but .editorconfig sets end_of_line = crlf in the global [*] section and does not override it for Markdown. As written, “follow .editorconfig and .gitattributes when they differ” doesn’t tell readers which source wins for .md, and editors honoring EditorConfig may continually rewrite Markdown to CRLF.
Recommend clarifying precedence for line endings (typically: .gitattributes is authoritative for EOL normalization) and/or explicitly calling out the EditorConfig vs gitattributes discrepancy for .md so contributors don’t fight line-ending churn.
| - Follow `.editorconfig` and `.gitattributes` when they differ from editor defaults. | |
| - Follow repo formatting config over editor defaults; if `.editorconfig` and `.gitattributes` disagree on line endings, treat `.gitattributes` as authoritative for EOL normalization. |
| - Avoid hardcoded machine-specific paths; use script-relative or environment-aware paths. | ||
| - Follow repo formatting rules exactly: | ||
| - `.ahk`, `.ps1`, `.cmd`, `.bat` -> CRLF, UTF-8, 4 spaces | ||
| - `.md`, `.json`, `.yml`, `.yaml` -> LF |
There was a problem hiding this comment.
This formatting bullet says Markdown should be LF, which matches .gitattributes, but note that .editorconfig currently sets end_of_line = crlf globally and doesn’t override it for *.md. Editors that apply EditorConfig will likely save Markdown with CRLF, causing noisy diffs that Git later normalizes back to LF.
Suggestion: add a short note here (or in AGENTS.md) that line endings are enforced by .gitattributes and contributors should not rely on EditorConfig for Markdown EOLs unless the repo aligns the settings.
| - `.md`, `.json`, `.yml`, `.yaml` -> LF | |
| - `.md`, `.json`, `.yml`, `.yaml` -> LF | |
| - For Markdown, treat `.gitattributes` as the source of truth for line endings; do not rely on EditorConfig for `*.md` unless those settings are aligned. |
This updates the repository’s AI guidance so it has a single canonical source and less drift between agent-specific files.
AGENTS.mdnow carries the durable repo rules, while.github/copilot-instructions.mdis reduced to a concise Copilot entrypoint that references it.Canonical guidance
AGENTS.mdinto the primary repository guide for AI agents.Copilot-specific instructions
.github/copilot-instructions.mdcontent with a compact operating summary.AGENTS.mdfor detailed guidance instead of maintaining two large parallel docs.Symlink contract
CLAUDE.mdas a symlink toAGENTS.md.AGENTS.mdis the canonical file andCLAUDE.mdshould continue resolving to it.Example of the new contract: