Add Copilot code-review instructions#221
Merged
Merged
Conversation
Give GitHub Copilot code review the repo's conventions so it reviews with context: the no-em-dash rule for user-facing copy, examples as teaching artifacts using house idioms, illustrative vs runnable doc snippets, typed default factories for strict pyright, the nullable-usage contract, and the strict-pyright / ruff toolchain. Reduces style-nit noise on PRs.
There was a problem hiding this comment.
Pull request overview
Adds a repository-level Copilot code review instruction file so automated reviews follow OpenArmature’s spec-first and tooling conventions rather than re-deriving style guidance each run.
Changes:
- Introduces
.github/copilot-instructions.mddocumenting review conventions (spec-as-source-of-truth, no-em-dash for user-facing copy, examples/doc snippet expectations). - Captures Python toolchain expectations (Python 3.12+, strict pyright, ruff) and provider/error-handling guidance for consistent review feedback.
- Flags generated paths (e.g., shipped
AGENTS.md,_patterns/) as non-hand-written to reduce review noise.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
The error-category line read as if six categories were the complete canonical set; reword to describe the retrieval-applicable subset mapped by status and point at openarmature.llm.errors for the full taxonomy (PR #221 review).
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.
Adds
.github/copilot-instructions.mdso GitHub Copilot code review runs with the repo's conventions instead of re-deriving style opinions each pass.Encodes the conventions that generated review noise: the no-em-dash rule for user-facing copy, examples as teaching artifacts using house idioms (lazy providers, moon-themed, no spec refs,
build_graph()factory), illustrative vs runnable documentation snippets, typed default factories for strict pyright (Field(default_factory=list[int])), the nullable-usage contract (usage = Noneis the spec contract, never fabricated), and the strict-pyright / ruff toolchain. Also marks the generatedAGENTS.md/_patterns/as not-hand-written.Pairs with two GitHub settings changes: per-push re-review turned off (auto-review remains on per PR), plus custom coding guidelines and generated-file path exclusions in Settings.