Skip to content

Commit e6a81b3

Browse files
committed
docs: add Copilot instructions for code review guidance
Instructs code review agents to: - Focus on build scripts, workflows, and psdocs-azure package - Treat packages/psdocs and packages/vscode-extension as vendored (git subtree imports) - skip unless critical security issue
1 parent e01330e commit e6a81b3

File tree

1 file changed

+43
-0
lines changed

1 file changed

+43
-0
lines changed

.github/copilot-instructions.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Copilot Instructions for PSDocs.Azure Monorepo
2+
3+
## Code Review Guidelines
4+
5+
When performing a code review, prioritize CI/CD correctness, build scripts, and monorepo structure changes.
6+
7+
### Focus review comments on:
8+
- `build.ps1` - Root build orchestrator
9+
- `build/common.ps1` - Shared build utilities
10+
- `.github/workflows/**` - CI/CD workflows
11+
- `.github/skills/**` - Copilot skills
12+
- `packages/psdocs-azure/**` - Core PSDocs.Azure module
13+
- `MONOREPO_MIGRATION.md` - Migration documentation
14+
15+
### Treat these paths as imported/vendored (git subtree). Do not leave review comments unless there is a critical security issue:
16+
- `packages/psdocs/**` - Imported from microsoft/PSDocs
17+
- `packages/vscode-extension/**` - Imported from microsoft/PSDocs-vscode (except `.github/workflows/` changes)
18+
19+
## Build System
20+
21+
This is a PowerShell-based monorepo using InvokeBuild:
22+
23+
```powershell
24+
# Build all packages
25+
./build.ps1 -Build
26+
27+
# Build specific package
28+
./build.ps1 -Package psdocs-azure -Build -Test
29+
```
30+
31+
## Versioning
32+
33+
Each component uses independent versioning with prefixed tags:
34+
- PSDocs: `psdocs-v{version}`
35+
- PSDocs.Azure: `psdocs-azure-v{version}`
36+
- VS Code Extension: `vscode-v{version}`
37+
38+
## CI/CD
39+
40+
Path-based filtering triggers builds only for changed packages:
41+
- `packages/psdocs/**` → PSDocs build
42+
- `packages/psdocs-azure/**` → PSDocs.Azure build
43+
- `packages/vscode-extension/**` → VS Code extension build

0 commit comments

Comments
 (0)