Skip to content

Refactor copilot-instructions.md into focused instruction files with PR review guidelines#695

Merged
nchapagain001 merged 9 commits intomainfrom
copilot/explain-repository-structure
Apr 24, 2026
Merged

Refactor copilot-instructions.md into focused instruction files with PR review guidelines#695
nchapagain001 merged 9 commits intomainfrom
copilot/explain-repository-structure

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 23, 2026

  • Remove documentation.instructions.md
  • Remove explicit version numbers from library references in copilot-instructions.md (e.g., Newtonsoft.Json 13.0.3Newtonsoft.Json)

Copilot AI and others added 5 commits April 23, 2026 18:18
…ntions and patterns

Agent-Logs-Url: https://github.com/microsoft/VirtualClient/sessions/02aeb2ce-6190-40ff-9285-7e7b7bec8d14

Co-authored-by: nchapagain001 <165215502+nchapagain001@users.noreply.github.com>
- Fix Serilog package name: Serilog.Extensions.Logging (not Serilog)
- Fix LogMetrics example to match actual signature from OpenSslExecutor.cs
- Fix profile example to use actual content from PERF-CPU-OPENSSL.json
- Fix DI service list to match actual CommandBase.cs registrations
- Add citation comments throughout for every claim

Agent-Logs-Url: https://github.com/microsoft/VirtualClient/sessions/f2cfe3e1-91c6-4cbc-ad70-4a8a1e7af274

Co-authored-by: nchapagain001 <165215502+nchapagain001@users.noreply.github.com>
Add a new 'PR Review Guidelines' section with two subsections:
- Required Fixes (10 items): things that break the build or crash at runtime,
  including constructor signature, base class inheritance, assembly attribute,
  profile Type matching, parser hierarchy, central package management, using
  placement, exception hierarchy, test category attributes, and copyright header.
- Suggestions (9 items): convention inconsistencies that won't break but should
  be addressed, including parameter access pattern, platform attribute, MockFixture
  inheritance, using ordering, field naming, XML docs, parser test data, Validate
  pattern, and async naming.

Every rule is cited to specific files and line numbers in the repo.

Agent-Logs-Url: https://github.com/microsoft/VirtualClient/sessions/7e265018-d4c1-422a-8fc9-d7d0b387a0cd

Co-authored-by: nchapagain001 <165215502+nchapagain001@users.noreply.github.com>
Split the 535-line monolithic file into 9 focused files, each ≤100 lines:
- .github/copilot-instructions.md (73 lines) — overview, tech stack, architecture, build/test
- .github/instructions/csharp.instructions.md (88 lines) — C# coding standards
- .github/instructions/testing.instructions.md (77 lines) — test patterns
- .github/instructions/documentation.instructions.md (37 lines) — doc formatting
- .github/instructions/pr-review.instructions.md (59 lines) — PR review rules
- .github/instructions/profile-review.instructions.md (64 lines) — profile rules
- .github/instructions/workload-development.instructions.md (80 lines) — workload dev
- .github/instructions/MetricsParser.instructions.md (95 lines) — parser patterns
- .github/instructions/ClientServer-Workloads.instructions.md (90 lines) — client/server

Each file has proper frontmatter with applyTo glob and description.
No content is duplicated across files.

Agent-Logs-Url: https://github.com/microsoft/VirtualClient/sessions/284221cb-f2b7-47a2-9538-840584055261

Co-authored-by: nchapagain001 <165215502+nchapagain001@users.noreply.github.com>
- copilot-instructions.md: fix lifecycle order (add IsSupported), remove error handling
  and DI service list duplication
- csharp.instructions.md: add this. prefix convention
- pr-review.instructions.md: remove suggestions that duplicate csharp conventions
- profile-review.instructions.md: narrow applyTo glob to profiles/, remove client/server
  section duplicated in ClientServer-Workloads
- MetricsParser.instructions.md: replace incomplete unit list with full list from source,
  fix placeholder in Preprocess example
- ClientServer-Workloads.instructions.md: rewrite to fix SupportedRoles field shadowing
  base property, add proper constructor deps matching ExampleClientServerExecutor,
  add concrete SetServerOnline/PollForHeartbeat sync patterns
- workload-development.instructions.md: add Validate override to template
- testing.instructions.md: add assertion examples with MetricAssert.Exists
- documentation.instructions.md: rewrite with VirtualClient-specific rules (Docusaurus
  site structure, workload doc template, metric tables)

Agent-Logs-Url: https://github.com/microsoft/VirtualClient/sessions/5e869f39-3937-4d40-a653-352d7f90de4f

Co-authored-by: nchapagain001 <165215502+nchapagain001@users.noreply.github.com>
…-references

- Rename ClientServer-Workloads.instructions.md → client-server-workloads.instructions.md
- Rename MetricsParser.instructions.md → metrics-parser.instructions.md
- Update cross-reference in workload-development.instructions.md
- Deduplicate exception handling: pr-review now references csharp for the detailed list

Agent-Logs-Url: https://github.com/microsoft/VirtualClient/sessions/166d6345-47e7-4cc6-a97a-80b517ed55cb

Co-authored-by: nchapagain001 <165215502+nchapagain001@users.noreply.github.com>
Agent-Logs-Url: https://github.com/microsoft/VirtualClient/sessions/7c69f96c-828d-4b13-85ea-9e9aef0c01bb

Co-authored-by: nchapagain001 <165215502+nchapagain001@users.noreply.github.com>
@nchapagain001 nchapagain001 marked this pull request as ready for review April 23, 2026 23:48
…structions.md

Agent-Logs-Url: https://github.com/microsoft/VirtualClient/sessions/e6210446-9382-456c-ad55-a4744cf27408

Co-authored-by: nchapagain001 <165215502+nchapagain001@users.noreply.github.com>
@nchapagain001 nchapagain001 merged commit b327939 into main Apr 24, 2026
5 checks passed
@nchapagain001 nchapagain001 deleted the copilot/explain-repository-structure branch April 24, 2026 01:09
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