Realign copilot-instructions.md with ProjectTemplate lean form - #439
Merged
Conversation
Carry the template's whole-file copilot-instructions.md (Commit/PR-title conventions, the Copilot Review Runbook, and When in Doubt) and drop the NxWitness-specific preamble that already lives in AGENTS.md (Solution Summary, CI Pipeline, Versioning, etc.). Adaptations: keep only the .NET CODESTYLE pointer (drop Python), drop devcontainer mentions (none here), fill owner/repo as ptr727/NxWitness, and retarget AGENTS.md cross-links to this repo's sections (#versioning, #pr-review-etiquette); the template's verbatim-carry and staying-in-sync links point upstream where this repo has no equivalent section. Closes #418.
There was a problem hiding this comment.
Pull request overview
Updates NxWitness’ .github/copilot-instructions.md to match the lean ptr727/ProjectTemplate form, keeping repo-wide conventions centralized in AGENTS.md while retaining commit/PR-title guidance and the Copilot review runbook mechanics.
Changes:
- Replaces the NxWitness-specific preamble with the template’s narrower “Copilot Instructions” structure.
- Keeps .NET-only style pointer (
CODESTYLE.md) and retains the Copilot review runbook withptr727/NxWitnesssnippet targeting. - Adds/standardizes commit message and PR title conventions (merge-method expectations, examples, and rules).
ptr727
added a commit
that referenced
this pull request
Jun 24, 2026
Periodic re-sync of the template-carried artifacts against [`ptr727/ProjectTemplate`](https://github.com/ptr727/ProjectTemplate) (tip `8a701a9`), plus the staged workspace dictionary/extension change. ## What changed - **`.github/copilot-instructions.md`** — adopt the template's current lean Copilot runbook: Merge Gate awareness, "a review with no inline comments is still a completed review", and round-1 auto-seed polling. This also fixes the file's LF line-ending drift (`.editorconfig` mandates CRLF for `.md`) and the regression from #439, which had realigned to an older/leaner form than the template now ships. Owner/repo placeholders filled; the per-language pointer drops Python (this repo is .NET-only). - **`AGENTS.md`** — carry the upgraded **PR Review Etiquette** contract verbatim (new **Merge Gate** subsection, "no-findings is a valid terminal outcome"). Added the **Pull Request Title and Commit Message Conventions** section that the lean runbook now links to. The `Release Model` anchor/`PUBLISH_ON_MERGE` reference were adapted to this repo's `CI Pipeline` section. Fixed a `.Net Format` → `.NET Format` task reference. - **`CODESTYLE.md`** — restructure to the template's **General + .NET** shape; drop the Python section; adapt the project list to `CreateMatrix`/`CreateMatrixTests` and `InternalsVisibleTo` accordingly. **Husky.Net is retained** as this repo's style gate (maintainer decision) — the template dropped it only because hooks don't fit non-.NET repos. - **`.editorconfig`, `.markdownlint-cli2.jsonc`** — pull current comments verbatim. - **`.vscode/tasks.json`** — rename `.Net` → `.NET`, add `dependsOrder: sequence` to `.NET Format`, keep the project-specific `Husky.Net Run` task; updated `.vscode/launch.json` and `.husky/task-runner.json` label references. - **`NxWitness.code-workspace`** — the staged change (`hddpool` dictionary word; swap `gruntfuggly.todo-tree` for `fanaticpythoner.better-todo-tree`). ## Notes - Versioning is unchanged; this is a maintenance re-sync. - Two upstream issues will be filed in `ptr727/ProjectTemplate`: (1) commit-gate confusion — Husky's absence is a non-.NET-fit concern, not a recommendation against gates; (2) verbatim-carry coherence gaps where carried files reference template-only sections/anchors (`#release-model`, the commit-conventions section, `#files-and-sections-derived-repos-must-carry-verbatim`). - Markdownlint clean on all three docs.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Completes the last open item of #418 (realign with
ptr727/ProjectTemplate). Items 2–5 were already resolved by #422 and the rulesets are correct (developsquash-only,mainmerge-only, lowercase names); only.github/copilot-instructions.mdstill diverged.Change
Carry the template's whole-file
.github/copilot-instructions.md(verbatim drop-in):# Copilot Instructions→ Commit Messages and Pull Request Titles → GitHub Copilot Review Runbook (unchanged from #422) → When in Doubt. Drops the NxWitness-specific preamble (Purpose, Solution Summary, CI Pipeline, standalone Versioning, etc.) — all already in AGENTS.md.Adaptations (per the carry contract)
CODESTYLE.mdpointer (drop Python); drop devcontainer mentions (none here).owner/repoasptr727/NxWitnessin the runbook snippets; keep<N>placeholders.#release-model→#versioning; keep#pr-review-etiquette). The template's "Files…Must Carry Verbatim" and "Staying in Sync" links point upstream, since this repo's AGENTS.md has no equivalent sections.Out of scope
Versioning is unchanged — it already matches the template; making it functional is a separate template-level effort.
Notes
Doc-only, no code. An upstream issue will be filed against
ptr727/ProjectTemplatere: the carried file linking to AGENTS.md sections a derived repo only has if it also carries the template's AGENTS.md structure.Closes #418.