Add code review standards to GitHub Copilot configuration
This commit is contained in:
parent
6870883d7e
commit
0d4b922e45
@ -31,6 +31,7 @@ Create specific instruction files:
|
|||||||
- `documentation.instructions.md` - Documentation requirements
|
- `documentation.instructions.md` - Documentation requirements
|
||||||
- `security.instructions.md` - Security best practices
|
- `security.instructions.md` - Security best practices
|
||||||
- `performance.instructions.md` - Performance optimization guidelines
|
- `performance.instructions.md` - Performance optimization guidelines
|
||||||
|
- `code-review.instructions.md` - Code review standards and GitHub review guidelines
|
||||||
|
|
||||||
### 3. `.github/prompts/` Directory
|
### 3. `.github/prompts/` Directory
|
||||||
Create reusable prompt files:
|
Create reusable prompt files:
|
||||||
@ -161,7 +162,8 @@ project-root/
|
|||||||
│ │ ├── testing.instructions.md
|
│ │ ├── testing.instructions.md
|
||||||
│ │ ├── documentation.instructions.md
|
│ │ ├── documentation.instructions.md
|
||||||
│ │ ├── security.instructions.md
|
│ │ ├── security.instructions.md
|
||||||
│ │ └── performance.instructions.md
|
│ │ ├── performance.instructions.md
|
||||||
|
│ │ └── code-review.instructions.md
|
||||||
│ ├── prompts/
|
│ ├── prompts/
|
||||||
│ │ ├── setup-component.prompt.md
|
│ │ ├── setup-component.prompt.md
|
||||||
│ │ ├── write-tests.prompt.md
|
│ │ ├── write-tests.prompt.md
|
||||||
@ -190,6 +192,15 @@ tags: ["language", "framework", "best-practices"]
|
|||||||
---
|
---
|
||||||
```
|
```
|
||||||
|
|
||||||
|
**Note**: For `code-review.instructions.md`, use:
|
||||||
|
```yaml
|
||||||
|
---
|
||||||
|
applyTo: ["**/*"]
|
||||||
|
description: "Code review standards and GitHub review guidelines"
|
||||||
|
tags: ["code-review", "github", "quality-assurance"]
|
||||||
|
---
|
||||||
|
```
|
||||||
|
|
||||||
**Prompts (.prompt.md):**
|
**Prompts (.prompt.md):**
|
||||||
```yaml
|
```yaml
|
||||||
---
|
---
|
||||||
@ -240,6 +251,7 @@ Before completing, verify:
|
|||||||
- [ ] Security and performance considerations are addressed
|
- [ ] Security and performance considerations are addressed
|
||||||
- [ ] Testing guidelines are included
|
- [ ] Testing guidelines are included
|
||||||
- [ ] Documentation standards are clear
|
- [ ] Documentation standards are clear
|
||||||
|
- [ ] Code review standards are defined
|
||||||
|
|
||||||
## Workflow Template Structure
|
## Workflow Template Structure
|
||||||
|
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user