Skip to content

docs: consolidate agent guidance and trim Copilot instructions#49

Merged
Ven0m0 merged 1 commit intomainfrom
copilot/update-agents-and-copilot-instructions
Apr 3, 2026
Merged

docs: consolidate agent guidance and trim Copilot instructions#49
Ven0m0 merged 1 commit intomainfrom
copilot/update-agents-and-copilot-instructions

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 3, 2026

This updates the repository’s AI guidance so it has a single canonical source and less drift between agent-specific files. AGENTS.md now carries the durable repo rules, while .github/copilot-instructions.md is reduced to a concise Copilot entrypoint that references it.

  • Canonical guidance

    • Reworked AGENTS.md into the primary repository guide for AI agents.
    • Kept only durable, repo-specific guidance: repo map, AHK v1/v2 boundaries, shared-library cautions, formatting rules, and CI source of truth.
    • Removed stale/high-churn details such as file counts, oversized examples, and duplicated setup content.
  • Copilot-specific instructions

    • Replaced the long duplicated .github/copilot-instructions.md content with a compact operating summary.
    • Pointed Copilot back to AGENTS.md for detailed guidance instead of maintaining two large parallel docs.
  • Symlink contract

    • Preserved CLAUDE.md as a symlink to AGENTS.md.
    • Clarified in the docs that AGENTS.md is the canonical file and CLAUDE.md should continue resolving to it.

Example of the new contract:

# GitHub Copilot Instructions

Use `AGENTS.md` as the canonical repository guide. This file is the short entry point for Copilot.

Agent-Logs-Url: https://github.com/Ven0m0/Scripts/sessions/8faee965-db36-4c34-b3e6-9aadbeb16f1f

Co-authored-by: Ven0m0 <82972344+Ven0m0@users.noreply.github.com>
@Ven0m0 Ven0m0 marked this pull request as ready for review April 3, 2026 11:42
Copilot AI review requested due to automatic review settings April 3, 2026 11:42
@Ven0m0 Ven0m0 merged commit 03e3f6b into main Apr 3, 2026
5 of 8 checks passed
@kilo-code-bot
Copy link
Copy Markdown

kilo-code-bot bot commented Apr 3, 2026

Code Review Summary

Status: No Issues Found | Recommendation: Merge

This PR is a documentation consolidation effort with no code changes. It simplifies AI agent guidance files:

  • Reduces .github/copilot-instructions.md from ~322 lines to ~26 lines
  • Reduces AGENTS.md from ~741 lines to ~84 lines
  • Establishes AGENTS.md as the canonical source of truth
  • Maintains the CLAUDE.md symlink to AGENTS.md

No security concerns, runtime errors, or logic issues - these are purely documentation/text file changes.

Files Reviewed (2 files)
  • .github/copilot-instructions.md - documentation consolidation
  • AGENTS.md - documentation consolidation

Reviewed by minimax-m2.5-20260211 · 90,701 tokens

@Ven0m0 Ven0m0 deleted the copilot/update-agents-and-copilot-instructions branch April 3, 2026 11:42
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.md with a concise, durable “source of truth” focused on repo map, v1/v2 boundaries, shared-library cautions, formatting, and CI references.
  • Reduced .github/copilot-instructions.md to a compact operating summary that references AGENTS.md instead 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.
Copy link

Copilot AI Apr 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
- 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.

Copilot uses AI. Check for mistakes.
- 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
Copy link

Copilot AI Apr 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
- `.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.

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants