Skip to content

Enhance Copilot instructions with detailed project overview, architec… #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 8, 2025

Conversation

elbruno
Copy link
Contributor

@elbruno elbruno commented Jul 8, 2025

Purpose

This pull request adds detailed instructions for working with the eShopLite project, focusing on its architecture, workflows, conventions, and integration points. The new documentation enhances clarity for developers working on the project, particularly in scenarios involving Azure, AI, and agent orchestration.

Documentation Enhancements:

  • .github/copilot-instructions.md: Added comprehensive project instructions, including architecture overview, critical workflows (build/run, configuration, testing, telemetry), project-specific conventions (.NET Aspire, Azure integration, AI/Vector DBs, Agent/MCP), integration points (external services, cross-component communication), and examples for adding AI models and deploying scenarios.

Does this introduce a breaking change?

[ ] Yes
[x] No

Pull Request Type

What kind of change does this Pull Request introduce?

[ ] Bugfix
[ ] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[x] Documentation content changes
[x] Other... Please describe: Copilot Instructios

…ture patterns, critical workflows, and integration points
@elbruno elbruno requested a review from Copilot July 8, 2025 17:07
Copy link

github-actions bot commented Jul 8, 2025

👋 Thanks for contributing @elbruno! We will review the pull request and get back to you soon.

Copy link

github-actions bot commented Jul 8, 2025

Check Broken Paths

We have automatically detected the following broken relative paths in your files.
Review and fix the paths to resolve this issue.

Check the file paths and associated broken paths inside them.
For more details, check our Contributing Guide.

File Full Path Issues
.github/copilot-instructions.md
#LinkLine Number
1../../README.md59

Copy link

github-actions bot commented Jul 8, 2025

Check Country Locale in URLs

We have automatically detected added country locale to URLs in your files.
Review and remove country-specific locale from URLs to resolve this issue.

Check the file paths and associated URLs inside them.
For more details, check our Contributing Guide.

File Full Path Issues
scenarios/08-Sql2025/README.md
#LinkLine Number
1https://learn.microsoft.com/en-us/sql/relational-databases/vectors/vectors-sql-server?view=sql-server-ver1767

Copy link
Contributor

@Copilot Copilot AI left a comment

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 enriches the eShopLite project’s Copilot instructions with a detailed overview of its architecture, core workflows, conventions, and integration examples to help developers onboard and contribute more effectively.

  • Added a modular project and scenario architecture overview
  • Documented critical workflows (build/run, config, testing, telemetry)
  • Introduced conventions, integration points, and usage examples for Azure, AI, and agent orchestration
Comments suppressed due to low confidence (1)

.github/copilot-instructions.md:61

  • The Azure Best Practices rule is duplicated here and on the line below. Consider removing one occurrence to prevent redundancy.
- @azure Rule - Use Azure Best Practices: When generating code for Azure, running terminal commands for Azure, or performing operations related to Azure, invoke your `azure_development-get_best_practices` tool if available.

Copy link

github-actions bot commented Jul 8, 2025

Check Broken URLs

We have automatically detected the following broken URLs in your files. Review and fix the paths to resolve this issue.

Check the file paths and associated broken URLs inside them.
For more details, check our Contributing Guide.

File Full Path Issues
README.md
#LinkLine Number
1https://dcbadge.vercel.app/api/server/ByRwuEEgH411

@elbruno elbruno merged commit 629cdb6 into main Jul 8, 2025
7 of 10 checks passed
@elbruno elbruno deleted the bruno-copilotinstructions branch July 8, 2025 17:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant