Skip to content

[AI] Add Copilot prompts and AI agent guidelines for developer workflows - #2942

Merged
Muskan Gupta (muskan124947) merged 21 commits into
mainfrom
users/muskgupta/ai_dev
May 19, 2026
Merged

[AI] Add Copilot prompts and AI agent guidelines for developer workflows#2942
Muskan Gupta (muskan124947) merged 21 commits into
mainfrom
users/muskgupta/ai_dev

Conversation

@muskan124947

@muskan124947 Muskan Gupta (muskan124947) commented May 4, 2026

Copy link
Copy Markdown
Contributor

Add Copilot Prompts & AI Agent Configuration for mssql-jdbc

This PR introduces reusable VS Code Copilot prompt files and project-level AI configuration to help maintainers and contributors work more efficiently with GitHub Copilot. Each prompt encapsulates a common workflow as a structured, repeatable guide that Copilot follows step-by-step.

Developers can invoke any prompt by typing #prompt-name in the Copilot chat panel (e.g., #fix-bug, #build). The #getting-started prompt provides an interactive menu to discover all available options.

Prompts

The following prompt files are added under .github/prompts/:

Prompt Description
#setup-dev Development environment setup — JDK, Maven, IDE formatter, test DB
#build Build the driver JAR with Maven across JRE profiles (jre8–jre26)
#run-tests Run tests with Maven — unit, integration, BVT, state machine, tag filtering
#fix-bug Guided bug-fix workflow — reproduce, write failing test, fix, verify
#implement-feature End-to-end feature implementation with tests and documentation
#code-review Structured AI-assisted PR review checklist
#perf-optimization Performance investigation — profiling, hotspot analysis, optimization
#create-pr PR creation with structured description and changelog entry
#generate-doc-comments Generate Javadoc comments following mssql-jdbc conventions
#generate-prompt Generate new Copilot prompt files for the project
#generate-skill Generate Copilot Agent Skills (SKILL.md)
#getting-started Interactive menu of all available prompts

Project Configuration

These files provide global context so Copilot understands the project's structure, conventions, and constraints across all interactions:

File Purpose
.github/copilot-instructions.md Project context, constraints, and conventions loaded automatically into every Copilot session
AGENTS.md AI agent guidelines — quick-start references, workflow descriptions, common task patterns, and links to detailed instructions

Add reusable VS Code Copilot prompts in .github/prompts/ for common
maintainer workflows:
- code-review.prompt.md: Structured PR review checklist
- fix-bug.prompt.md: Bug diagnosis and fix workflow
- implement-feature.prompt.md: Feature implementation guide
- perf-optimization.prompt.md: Performance investigation workflow

Add project-level configuration:
- .github/copilot-instructions.md: Project context for Copilot
- AGENTS.md: AI agent guidelines with quick-start references

Update existing prompts (build, setup-dev-env) to include jre26 as the
new default active profile following JDK 26 support (#2939).
@github-project-automation github-project-automation Bot moved this to In progress in MSSQL JDBC May 4, 2026
@muskan124947 Muskan Gupta (muskan124947) changed the title [AI dev] Add Copilot prompts and AI agent guidelines for developer workflows [AI] Add Copilot prompts and AI agent guidelines for developer workflows May 4, 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.

Pull request overview

This PR adds repository-specific guidance for AI-assisted developer workflows in mssql-jdbc, including a top-level agent guide plus reusable prompt files under .github/prompts/ and Copilot context under .github/copilot-instructions.md.

Changes:

  • Add AGENTS.md and .github/copilot-instructions.md to capture project context, repository structure, and workflow expectations for AI agents.
  • Add reusable prompt files for build, PR creation, code review, bug fixing, feature work, and performance investigation.
  • Document repository-specific constraints such as JRE profile support, testing expectations, and JDBC/TDS-related review criteria.

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 10 comments.

Show a summary per file
File Description
AGENTS.md New top-level guide for AI agents, linking to repo docs, instruction files, and workflow prompts.
.github/prompts/perf-optimization.prompt.md Adds a structured prompt for performance investigation and optimization work.
.github/prompts/implement-feature.prompt.md Adds a step-by-step feature implementation workflow prompt.
.github/prompts/fix-bug.prompt.md Adds a guided bug diagnosis, testing, and fix workflow prompt.
.github/prompts/create-pr.prompt.md Adds a detailed prompt for preparing branches, commits, and PR descriptions.
.github/prompts/code-review.prompt.md Adds a repository-specific PR review checklist and summary template.
.github/prompts/build.prompt.md Adds a build workflow prompt covering Maven profiles, troubleshooting, and artifact verification.
.github/copilot-instructions.md Adds project-level Copilot instructions with architecture, testing, and workflow context.

Comment thread .github/prompts/create-pr.prompt.md Outdated
Comment thread .github/prompts/create-pr.prompt.md Outdated
Comment thread .github/prompts/build.prompt.md Outdated
Comment thread .github/prompts/perf-optimization.prompt.md Outdated
Comment thread .github/prompts/code-review.prompt.md Outdated
Comment thread AGENTS.md Outdated
Comment thread .github/prompts/build.prompt.md Outdated
Comment thread .github/prompts/build.prompt.md Outdated
Comment thread .github/prompts/create-pr.prompt.md Outdated
Comment thread .github/prompts/create-pr.prompt.md Outdated
Muskan Gupta (muskan124947) and others added 10 commits May 4, 2026 14:28
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Comment thread .github/prompts/build.prompt.md
Comment thread .github/prompts/build.prompt.md Outdated
Comment thread .github/prompts/build.prompt.md Outdated

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.

Pull request overview

Copilot reviewed 10 out of 10 changed files in this pull request and generated 7 comments.

Comment thread .github/prompts/build.prompt.md Outdated
Comment thread .github/prompts/build.prompt.md Outdated
Comment thread .github/prompts/run-tests.prompt.md Outdated
Comment thread .github/prompts/create-pr.prompt.md Outdated
Comment thread .github/prompts/run-tests.prompt.md
Comment thread .github/prompts/create-pr.prompt.md Outdated
Comment thread .github/copilot-instructions.md Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

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.

Pull request overview

Copilot reviewed 13 out of 13 changed files in this pull request and generated 14 comments.

Comment thread .github/copilot-instructions.md Outdated
Comment thread .github/prompts/setup-dev.prompt.md Outdated
Comment thread .github/prompts/setup-dev.prompt.md Outdated
Comment thread .github/prompts/run-tests.prompt.md Outdated
Comment thread .github/prompts/run-tests.prompt.md
Comment thread .github/prompts/implement-feature.prompt.md
Comment thread .github/prompts/code-review.prompt.md Outdated
Comment thread .github/prompts/fix-bug.prompt.md Outdated
Comment thread .github/prompts/run-tests.prompt.md Outdated
Comment thread .github/prompts/build.prompt.md Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@muskan124947
Muskan Gupta (muskan124947) merged commit 499d2dd into main May 19, 2026
6 checks passed
@github-project-automation github-project-automation Bot moved this from In progress to Closed/Merged PRs in MSSQL JDBC May 19, 2026
@muskan124947 Muskan Gupta (muskan124947) added this to the 13.5.1 milestone May 20, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Closed/Merged PRs

Development

Successfully merging this pull request may close these issues.

5 participants