Skip to content

Add evidence-based SqlClient code review skill - #4736

Merged
cheenamalhotra merged 9 commits into
mainfrom
dev/cheena/sqlclient-review-skill
Oct 1, 2026
Merged

cheenamalhotra merged 9 commits into
mainfrom
dev/cheena/sqlclient-review-skill

Conversation

@cheenamalhotra

@cheenamalhotra cheenamalhotra commented Sep 23, 2026 •

Copy link
Copy Markdown
Member

Description

  • Add a shared review skill informed by dotnet/runtime, dotnet/efcore, and microsoft/mssql-rs, with pinned sources.
  • Cover driver correctness, compatibility, pooling, TDS, async paths, and regression coverage.
  • Show outstanding feedback before code analysis, separating Copilot, other bots, and human reviewers. Reuse the sibling feedback skill's collection guidance when available from trusted policy.
  • Add concise finding examples and safeguards for permissions, automated publication, duplicate findings, and stale reviews.
  • Remove the redundant code-review prompt, link the skill from AGENTS.md, and correct unified reference-project guidance. No driver behavior changes or new automation.

Issues

N/A

Testing

Self-reviewed and addressed findings. Checked frontmatter, local links, reference links, anchors, whitespace, prompt removal, and feedback snapshot placement. Verified pinned upstream sources. Driver tests are not applicable to this documentation-only change.

Guidelines

  • Tests added or updated: N/A; documentation-only
  • Public API changes documented: N/A
  • Verified against customer repro: N/A
  • Ensure no breaking changes introduced

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 5e511be1-16f3-4ab0-a8d3-51efbde72763
@cheenamalhotra
cheenamalhotra requested review from a team and a balanced review from Copilot September 23, 2026 17:00
@github-project-automation github-project-automation Bot moved this to To triage in SqlClient Board Sep 23, 2026
@cheenamalhotra cheenamalhotra moved this from To triage to In review in SqlClient Board Sep 23, 2026
@cheenamalhotra cheenamalhotra added this to the 8.0.0-preview1 milestone Sep 23, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🟡 Changes recommended

Removing explicit tool scoping broadens prompt permissions and contradicts the stated read-only, no-automation-change scope.

Get a fresh assessment by requesting another Copilot review.

Review effort: Balanced
Findings: 1 High severity

Open (1)
What changed in this PR

Adds a reusable, evidence-based SqlClient review skill and routes the existing review prompt through it.

Changes:

  • Defines review workflow, driver checks, and publication safeguards.
  • Documents pinned upstream sources and reporting examples.
  • Simplifies the existing review prompt to use the shared skill.
File Description
.github/​skills/​sqlclient-code-review/​SKILL.md Defines the review procedure.
.github/​skills/​sqlclient-code-review/​references/​sources.md Records sources and adaptations.
.github/​skills/​sqlclient-code-review/​references/​reporting.md Defines reporting and publication rules.
.github/​skills/​sqlclient-code-review/​references/​driver-checks.md Adds SqlClient-specific review guidance.
.github/​prompts/​code-review.prompt.md Routes reviews through the skill.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread .github/prompts/code-review.prompt.md Outdated
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 5e511be1-16f3-4ab0-a8d3-51efbde72763
Copilot AI review requested due to automatic review settings September 23, 2026 17:09

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🔵 Needs a closer look

The driver-check reference incorrectly labels abbreviated paths as repository-relative, which can misdirect automated reviews.

Review effort: Balanced
Findings: None

Resolved since last review (1)
Previously missed (1)

In code that hasn't changed since last review

Low severity Incorrect repository-relative paths in file location table

.github/​skills/​sqlclient-code-review/​references/​driver-checks.md:5

The statement that all entries below are repository-relative is incorrect. For example, the table lists ConnectionPool/ChannelDbConnectionPool.cs, but the file is under src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/ConnectionPool/; several other entries are similarly abbreviated. This can send automated reviewers to nonexistent paths, so describe these as search starting points or expand them to full repository-relative paths.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 5e511be1-16f3-4ab0-a8d3-51efbde72763
Copilot AI review requested due to automatic review settings September 23, 2026 17:29

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🟡 Changes recommended

The prompt loads review instructions from the untrusted workspace instead of a trusted base revision.

Get a fresh assessment by requesting another Copilot review.

Review effort: Balanced
Findings: 1 High severity

Open (1)

Comment thread .github/prompts/code-review.prompt.md Outdated
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 5e511be1-16f3-4ab0-a8d3-51efbde72763
Copilot AI review requested due to automatic review settings September 23, 2026 17:36

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🟢 Approval recommended

The previous tool-scoping and trust-boundary concerns are addressed, with no remaining actionable defects found.

Review effort: Balanced
Findings: None

Resolved since last review (1)

@cheenamalhotra
cheenamalhotra enabled auto-merge (squash) September 23, 2026 18:01

@priyankatiwari08 priyankatiwari08 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docs/skill-only change. Two things:

  • Prompt says report the review as partial rather than using a terminal fallback, but SKILL.md says prefer gh for GitHub reads when available and documents an npx @microsoft/learn-cli fallback. Reconcile — as written an agent gets contradictory guidance on shell use.
  • See inline on the tools list.

Comment thread .github/prompts/code-review.prompt.md Outdated
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 5e511be1-16f3-4ab0-a8d3-51efbde72763
Copilot AI review requested due to automatic review settings September 24, 2026 15:15

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🟢 Approval recommended

The documentation-only changes are internally consistent, scoped appropriately, and address the prior tool and trust-boundary feedback.

Review effort: Balanced
Findings: None

@paulmedynski paulmedynski removed the Hotfix 7.1.1 PRs targeting main that should be backported to release/7.1 for 7.1.1. label Sep 25, 2026
Comment thread .github/prompts/code-review.prompt.md Outdated
Comment thread .github/skills/sqlclient-code-review/SKILL.md
@paulmedynski paulmedynski added the Hotfix 7.1.2 PRs targeting main that should be backported to release/7.1 for 7.1.2. label Sep 30, 2026
Remove the redundant code-review prompt and direct reviewers to the skill. Add a read-only feedback snapshot with conditional reuse of the sibling feedback skill.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 5e511be1-16f3-4ab0-a8d3-51efbde72763
Copilot AI balanced review requested due to automatic review settings October 1, 2026 07:06

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🟡 Changes recommended

The new workspace-relative skill link undermines the skill’s trusted-base safeguard.

Review effort: Balanced
Findings: 1 Low severity

Open (1)

Comment thread AGENTS.md Outdated
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 5e511be1-16f3-4ab0-a8d3-51efbde72763
Copilot AI balanced review requested due to automatic review settings October 1, 2026 07:20

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🔵 Needs a closer look

Existing feature and bug-fix prompts still direct agents to removed legacy reference directories.

Review effort: Balanced
Findings: None

Resolved since last review (1)
Previously missed (1)

In code that hasn't changed since last review

Low severity Replace obsolete API reference paths in agent prompts

.github/​instructions/​api-design.instructions.md:36

Update the API-changing prompts to match this unified reference path. implement-feature.prompt.md:29-33 and fix-bug.prompt.md:40 are still linked from AGENTS.md and direct agents to netcore/ref and netfx/ref, but those directories do not exist in this revision. Following either prompt will fail or recreate obsolete paths, so replace those legacy references with src/Microsoft.Data.SqlClient/ref/ and its conditional declarations.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 5e511be1-16f3-4ab0-a8d3-51efbde72763
Copilot AI balanced review requested due to automatic review settings October 1, 2026 07:37
@cheenamalhotra

Copy link
Copy Markdown
Member Author

Replace obsolete API reference paths in agent prompts

Fixed in c68baf0. Both feature and bug-fix prompts now use src/Microsoft.Data.SqlClient/ref/ and require matching conditional declarations for each affected framework.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🟢 Approval recommended

The documentation-only changes are internally consistent, local links resolve, and prior security concerns are addressed.

Review effort: Balanced
Findings: None

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🟢 Approval recommended

The documentation is internally consistent, links resolve, prior concerns are addressed, and the unified reference guidance matches the current project.

Review effort: Balanced
Findings: None

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Hotfix 6.1.8 Hotfix 7.0.4 Hotfix 7.1.2 PRs targeting main that should be backported to release/7.1 for 7.1.2.

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

5 participants