Skip to content

Commit 67af5de

Browse files
add instructions for copilot about the projects we have in this repo (Azure#51417)
* add instructions for copilot about the projects we have in this repo * Update .github/copilot-instructions.md Co-authored-by: Copilot <[email protected]> * Update .github/copilot-instructions.md Co-authored-by: Copilot <[email protected]> * add some typical workflow for azure management generator * add a section for azure generator --------- Co-authored-by: Copilot <[email protected]>
1 parent 41f7b08 commit 67af5de

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

.github/copilot-instructions.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,23 @@
1+
# Project Overview
2+
3+
This repo contains Azure SDKs for various Azure services and tools that generate them.
4+
5+
## Folder Structure
6+
7+
- `/eng/packages/http-client-csharp`: Contains the source code of the generator for Azure Data Plane SDKs (aka Azure Generator).
8+
- `/eng/packages/http-client-csharp-mgmt`: Contains the source code of the generator for Azure Management Plane SDKs (aka Azure Management Generator).
9+
- `/sdk`: Contains the individual SDKs for Azure services.
10+
11+
### Azure Generator
12+
13+
- Always run `npm install` in the `/eng/packages/http-client-csharp` directory before running the generator.
14+
- Always run `/eng/packages/http-client-csharp/eng/scripts/Generate.ps1` to regenerate the test projects to validate the result of generator code changes.
15+
16+
### Azure Management Generator
17+
18+
- Always run `npm install` in the `/eng/packages/http-client-csharp-mgmt` directory before running the generator.
19+
- Always run `/eng/packages/http-client-csharp-mgmt/eng/scripts/Generate.ps1` to regenerate the test projects to validate the result of generator code changes.
20+
121
## SDK release
222

323
There are two tools to help with SDK releases:

0 commit comments

Comments
 (0)