Skip to content

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

Merged
nanotaboada merged 2 commits intomasterfrom
docs/unify-copilot-instructions
Feb 19, 2026
Merged

docs(copilot): unify instructions as canonical single-file format#387
nanotaboada merged 2 commits intomasterfrom
docs/unify-copilot-instructions

Conversation

@nanotaboada
Copy link
Copy Markdown
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

Summary by CodeRabbit

  • Documentation
    • Restructured development guidance documentation with reorganized sections, expanded technical stack details, and refined workflow procedures for development operations.
    • Removed a comprehensive operational documentation file, consolidating essential guidance into the primary instruction resource.

@coderabbitai
Copy link
Copy Markdown

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 14 minutes and 50 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 pull request restructures the Copilot instructions documentation file by reorganizing sections, expanding guidance on workflows and conventions, and deletes the AGENTS.md file entirely, removing centralized developer-facing operational instructions.

Changes

Cohort / File(s) Summary
Documentation Restructuring
.github/copilot-instructions.md
Complete rewrite reorganizing sections from Core Conventions to Structure, Coding Guidelines, and Commands; expands Tech Stack details; introduces Quick Start, Pre-commit Checks, Commits, Agent Mode, and Key workflows subsections; replaces bullet lists with labeled sections and code blocks; shifts terminology and formatting (e.g., "Copilot Should" to "Coding Guidelines").
Documentation Removal
AGENTS.md
Entire file deleted, eliminating comprehensive developer documentation covering .NET version, development workflow, database management, Docker workflow, CI/CD pipelines, project architecture, configuration examples, API endpoints, troubleshooting guidance, and conventions (CHANGELOG, secrets, testing, commits, caching, logging, rate limiting, package management).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~5 minutes

Possibly related PRs

🚥 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 with 'docs:' prefix, is under 80 characters (65 chars), and accurately describes the main change: unifying two instruction files into a single canonical format.
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
Copy Markdown

@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: 2

🤖 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 109: The "Add an endpoint" workflow omits updating AutoMapper profiles
and repository methods; update the workflow text to include steps for
adding/updating the AutoMapper Profiles/ (e.g., create mapping for the new DTO
in Profiles/) and for adding necessary data-access logic in Repositories/ (e.g.,
add repository method(s) used by the new service), so the sequence becomes: add
DTO in Models/, update Profiles/ (AutoMapper), add repository method(s) in
Repositories/, add service method in Services/, add controller action in
Controllers/, add validator in Validators/, add tests, then run pre-commit
checks.
- Line 94: Remove the obsolete mention of azure-pipelines.yml from the CI/CD
list and update the "Add an endpoint" workflow guidance to also remind
contributors to update the AutoMapper profile (specifically the
PlayerMappingProfile class) when new DTOs or entity↔DTO mappings are introduced;
reference AutoMapper and PlayerMappingProfile so reviewers remember to add
mapping entries whenever endpoints add or change DTOs.

Comment thread .github/copilot-instructions.md Outdated
Comment thread .github/copilot-instructions.md Outdated
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

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@nanotaboada nanotaboada force-pushed the docs/unify-copilot-instructions branch from df455bd to 611b5cf Compare February 19, 2026 21:29
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@sonarqubecloud
Copy link
Copy Markdown

@nanotaboada nanotaboada merged commit fb57c3b into master Feb 19, 2026
11 checks passed
@nanotaboada nanotaboada deleted the docs/unify-copilot-instructions branch February 19, 2026 21:50
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