Skip to content

Comments

docs(copilot): unify instructions as canonical single-file format#269

Merged
nanotaboada merged 1 commit intomasterfrom
docs/unify-copilot-instructions
Feb 19, 2026
Merged

docs(copilot): unify instructions as canonical single-file format#269
nanotaboada merged 1 commit intomasterfrom
docs/unify-copilot-instructions

Conversation

@nanotaboada
Copy link
Owner

@nanotaboada nanotaboada commented Feb 19, 2026

Consolidate .github/copilot-instructions.md and AGENTS.md into a single always-on file with a consistent section order (Overview, Tech Stack, Structure, Coding Guidelines, Commands, Agent Mode).

  • Replace two-file system with one canonical copilot-instructions.md
  • Absorb AGENTS.md content (autonomy levels, workflows) into Agent Mode

This change is Reviewable

Summary by CodeRabbit

  • Documentation
    • Updated AI agent guidelines and instructions with reorganized content structure and streamlined formatting.
    • Consolidated and removed redundant documentation resources to reduce maintenance overhead.

@coderabbitai
Copy link

coderabbitai bot commented Feb 19, 2026

Warning

Rate limit exceeded

@nanotaboada has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 3 minutes and 54 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Walkthrough

This PR restructures AI agent guidance documentation by rewriting .github/copilot-instructions.md from project-oriented guidelines to an agent-friendly prescriptive format with sections like "Proceed freely," "Ask before changing," and "Key workflows." The standalone AGENTS.md file containing comprehensive agent documentation and workflows is deleted entirely.

Changes

Cohort / File(s) Summary
Documentation Restructuring
.github/copilot-instructions.md
Replaced detailed multi-section project guidelines (Overview, Tech Stack, Structure, Quick Start, Project Patterns, Code Conventions, Testing, Commit Messages) with agent-oriented sections. Removed granular rules on naming conventions, testing structure, and commit formatting; introduced high-level workflow guidance and contributor guardrails.
Documentation Deletion
AGENTS.md
Removed comprehensive agent documentation including project structure overview, common workflows (adding endpoints, modifying schema, running tests), autonomy levels, pre-commit checks, CI validation processes, API testing examples, and troubleshooting guides.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

  • PR #267: Overlapping, substantively similar restructurings of the same documentation files (copilot-instructions.md and AGENTS.md)
  • PR #229: Modifies the repository's Copilot instructions file; one adds comprehensive instructions while this PR replaces and reorganizes that same file
  • PR #255: Modifies the same documentation files with directly conflicting changes—this PR deletes AGENTS.md while the retrieved PR adds it for detailed procedures
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title follows Conventional Commits format (docs:), is 65 characters (under 80), and clearly describes the main change: unifying Copilot instructions into a single canonical file by consolidating two documentation files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/unify-copilot-instructions

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In @.github/copilot-instructions.md:
- Line 123: Update the Co-authored-by line that currently reads "Co-authored-by:
Copilot <223556219+Copilot@users.noreply.github.com>" by replacing the incorrect
numeric user ID 223556219 with the correct Copilot bot ID 175728472 so the line
becomes the same "Co-authored-by: Copilot
<175728472+Copilot@users.noreply.github.com>" ensuring co-author attribution
works; locate and edit the exact "Co-authored-by: Copilot
<...+Copilot@users.noreply.github.com>" string in the file to make this change.

@codecov
Copy link

codecov bot commented Feb 19, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (1266928) to head (c3205f0).
⚠️ Report is 2 commits behind head on master.

Additional details and impacted files
@@             Coverage Diff             @@
##              master      #269   +/-   ##
===========================================
  Coverage     100.00%   100.00%           
  Complexity        28        28           
===========================================
  Files              2         2           
  Lines             77        77           
  Branches           8         8           
===========================================
  Hits              77        77           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Consolidate .github/copilot-instructions.md and AGENTS.md into a
single always-on file with a consistent section order (Overview,
Tech Stack, Structure, Coding Guidelines, Commands, Agent Mode).

- Replace two-file system with one canonical copilot-instructions.md
- Absorb AGENTS.md content (autonomy levels, workflows) into Agent Mode
@nanotaboada nanotaboada force-pushed the docs/unify-copilot-instructions branch from 923612c to c3205f0 Compare February 19, 2026 21:27
@sonarqubecloud
Copy link

@nanotaboada nanotaboada merged commit 49cc920 into master Feb 19, 2026
9 checks passed
@nanotaboada nanotaboada deleted the docs/unify-copilot-instructions branch February 19, 2026 21:36
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.

1 participant