Skip to content

AI: add AGENTS.md and path-scoped review instructions - #578

Open
Gaurav Sharma (bewithgaurav) wants to merge 1 commit into
bewithgaurav/docs-copilot-instructions-refreshfrom
bewithgaurav/ai-agent-review-context
Open

AI: add AGENTS.md and path-scoped review instructions#578
Gaurav Sharma (bewithgaurav) wants to merge 1 commit into
bewithgaurav/docs-copilot-instructions-refreshfrom
bewithgaurav/ai-agent-review-context

Conversation

@bewithgaurav

Copy link
Copy Markdown
Collaborator

Adds repository context so GitHub Copilot code review reviews mssql-django with the backend's actual conventions and known failure modes, instead of generic advice. First step of the AI-assisted review initiative.

Stacked on #577 (DOCS refresh). Base will be retargeted to dev once #577 merges; until then the diff here is scoped to just this change.

What's added

  • AGENTS.md — durable project facts (default branch dev, version/support matrix, module map, commit/PR prefix grammar, history rules) plus cross-cutting review judgment (root-cause over workaround, classify by blast radius, silent-wrong-results severity, whole-file sweep when migrating off a deprecated API, exclusion comments as documentation).
  • .github/instructions/*.instructions.md — path-scoped review guidance loaded only when a matching file changes. One per backend area (schema, compiler, operations, functions, base, features, introspection) plus testapp/. Each encodes checks drawn from real prior issues/PRs (e.g. isinstance vs exact-type dispatch, ORDER BY dedup, MARS connection-string opt-out, feature-flag overrides on a new Django minor, mandatory regression tests under testapp/tests/).
  • .github/copilot-instructions.md — small dedup edits: a header describing the three-file split and pointers to AGENTS.md, so nothing is stated twice.

Documentation/configuration only. No backend code, no workflow, no test changes.

…ons)

Add AGENTS.md and .github/instructions/ so GitHub Copilot code review
reviews mssql-django with the backend's real conventions and known failure
modes instead of generic advice. AGENTS.md holds durable project facts and
cross-cutting review judgment; the eight path-scoped files (schema, compiler,
operations, functions, base, features, introspection, testapp) load only
when a matching path changes. Small dedup edits to copilot-instructions.md
point at AGENTS.md so nothing is stated twice. Docs/config only.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@bewithgaurav Gaurav Sharma (bewithgaurav) changed the title AI: bootstrap agent review context (AGENTS.md + path-scoped instructions) AI: add AGENTS.md and path-scoped review instructions Aug 17, 2026
@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
There may be pipelines that require an authorized user to comment /azp run to run.

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