Add missing copilot-instructions.md file to Boilerplate (#12316)

[zahra-yousefi]

closes #12316

Summary by CodeRabbit

• Documentation
  • Updated internal development guidelines and instructions for coding conventions and project structure reference.

[coderabbitai]

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 930fc49d-a949-42be-8cd7-5c566baf431f

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• 🔍 Trigger review

Walkthrough

A new copilot-instructions.md file is added to the Boilerplate project template, establishing AGENTS.md as the authoritative source for coding conventions, project structure, technology stack, and behavioral directives. The file instructs GitHub Copilot to read AGENTS.md in full before performing any task.

Changes

Copilot Instructions Reference

Layer / File(s)	Summary
Copilot Instructions Document src/Templates/Boilerplate/Bit.Boilerplate/copilot-instructions.md	New file with GitHub Copilot Instructions header and directive designating AGENTS.md as the single source of truth for coding conventions, requiring full reading before task execution.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A guiding paw points the way so clear,
To AGENTS.md, the truth held dear!
Copilot now knows where wisdom dwells,
In templates fair, this breadcrumb tells,
Conventions and directives combined,
A unified thread, the gold we find! ✨

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the main change: adding a missing copilot-instructions.md file to the Boilerplate project.
Linked Issues check	✅ Passed	The PR adds copilot-instructions.md that directs to AGENTS.md as the source of truth, directly addressing issue #12316's objective to improve Copilot's recognition of agent definitions.
Out of Scope Changes check	✅ Passed	All changes are directly related to the objective of adding a copilot-instructions.md file to help GitHub Copilot recognize AGENTS.md in the Boilerplate template.
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

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@src/Templates/Boilerplate/Bit.Boilerplate/copilot-instructions.md`:
- Around line 1-5: The copilot-instructions.md file is currently placed at
src/Templates/Boilerplate/Bit.Boilerplate/copilot-instructions.md which Copilot
won't discover; move this file into the Boilerplate template root so generated
projects place it at .github/copilot-instructions.md (i.e., update the template
source and any instantiation logic to write copilot-instructions.md to
.github/copilot-instructions.md relative to the generated project root), ensure
references to AGENTS.md remain unchanged, and update any template manifest or
copy routines that reference copilot-instructions.md to use the new destination
path.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: d54b763c-603d-4d95-9389-3709cda8eff0

📥 Commits

Reviewing files that changed from the base of the PR and between f0d0f10 and ca1e6e7.

📒 Files selected for processing (1)

• src/Templates/Boilerplate/Bit.Boilerplate/copilot-instructions.md