Skip to content

Commit 494f72e

Browse files
committed
Rename code-review skill to code-checklist and update related documentation. Regenerate related gifs.
1 parent 74805de commit 494f72e

8 files changed

Lines changed: 41 additions & 41 deletions

File tree

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
name: code-review
3-
description: Team code review checklist - use for reviewing Python code quality, bugs, security issues, and best practices
2+
name: code-checklist
3+
description: Team code quality checklist - use for checking Python code quality, bugs, security issues, and best practices
44
---
55

6-
# Code Review Skill
6+
# Code Checklist Skill
77

8-
Apply this checklist when reviewing Python code.
8+
Apply this checklist when checking Python code.
99

1010
## Code Quality Checklist
1111

@@ -33,7 +33,7 @@ Apply this checklist when reviewing Python code.
3333
Present findings as:
3434

3535
```
36-
## Code Review: [filename]
36+
## Code Checklist: [filename]
3737
3838
### Code Quality
3939
- [PASS/FAIL] Description of finding

05-skills/README.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Skills work the same way. Just like swapping drill bits for different jobs, you
3131
| `commit` | Generate consistent commit messages |
3232
| `security-audit` | Check for OWASP vulnerabilities |
3333
| `generate-tests` | Create comprehensive pytest tests |
34-
| `code-review` | Apply team code quality standards |
34+
| `code-checklist` | Apply team code quality standards |
3535

3636

3737

@@ -56,7 +56,7 @@ Learn what skills are, why they matter, and how they differ from agents and MCP.
5656
```
5757
This shows all skills Copilot can find in your project and personal folders.
5858

59-
2. **Look at a real skill file:** Check out our provided [code-review SKILL.md](../.github/skills/code-review/SKILL.md) to see the pattern. It's just YAML frontmatter plus markdown instructions.
59+
2. **Look at a real skill file:** Check out our provided [code-checklist SKILL.md](../.github/skills/code-checklist/SKILL.md) to see the pattern. It's just YAML frontmatter plus markdown instructions.
6060

6161
3. **Understand the core concept:** Skills are task-specific instructions that Copilot loads *automatically* when your prompt matches the skill's description. You don't need to activate them, just ask naturally.
6262

@@ -68,16 +68,16 @@ Agent Skills are folders containing instructions, scripts, and resources that Co
6868
```bash
6969
copilot
7070

71-
> Review books.py for code quality issues
72-
# Copilot detects this matches your "code-review" skill
71+
> Check books.py against our quality checklist
72+
# Copilot detects this matches your "code-checklist" skill
7373
# and automatically applies its Python quality checklist
7474

7575
> Generate tests for the BookCollection class
7676
# Copilot loads your "pytest-gen" skill
7777
# and applies your preferred test structure
7878

7979
> What are the code quality issues in this file?
80-
# Copilot loads your "code-review" skill
80+
# Copilot loads your "code-checklist" skill
8181
# and checks against your team's standards
8282
```
8383

@@ -92,15 +92,15 @@ While auto-triggering is the primary way skills work, you can also **invoke skil
9292
```bash
9393
> /generate-tests Create tests for the user authentication module
9494

95-
> /code-review Check books.py for code quality issues
95+
> /code-checklist Check books.py for code quality issues
9696

97-
> /security-audit Review the API endpoints
97+
> /security-audit Check the API endpoints for vulnerabilities
9898
```
9999

100100
This gives you explicit control when you want to ensure a specific skill is used.
101101

102102
> 📝 **Skills vs Agents Invocation**: Don't confuse skill invocation with agent invocation:
103-
> - **Skills**: `/skill-name <prompt>`, e.g., `/code-review Check this file`
103+
> - **Skills**: `/skill-name <prompt>`, e.g., `/code-checklist Check this file`
104104
> - **Agents**: `/agent` (select from list) or `copilot --agent <name>` (command line)
105105
>
106106
> If you have both a skill and an agent with the same name (e.g., "code-reviewer"), typing `/code-reviewer` invokes the **skill**, not the agent.
@@ -129,7 +129,7 @@ Skills are just one piece of GitHub Copilot's extensibility model. Here's how th
129129
| **Skills** | Provides task-specific instructions | Specific, repeatable tasks with detailed steps |
130130
| **MCP** | Connects external services | Need live data from APIs |
131131

132-
Use agents for broad expertise, skills for specific task instructions, and MCP for external data. An agent can use one or more skills during a conversation. For example, when you ask a code review agent to review your code, it might apply both a `security-audit` skill and a `style-guide` skill automatically.
132+
Use agents for broad expertise, skills for specific task instructions, and MCP for external data. An agent can use one or more skills during a conversation. For example, when you ask an agent to check your code, it might apply both a `security-audit` skill and a `code-checklist` skill automatically.
133133

134134
> 📚 **Learn More**: See the official [About Agent Skills](https://docs.github.com/copilot/concepts/agents/about-agent-skills) documentation for the complete reference on skill formats and best practices.
135135
@@ -162,17 +162,17 @@ Time: **30+ seconds** to type. Consistency: **varies by memory**.
162162

163163
### After Skills: Automatic Best Practices
164164

165-
With a `code-review` skill installed, just ask naturally:
165+
With a `code-checklist` skill installed, just ask naturally:
166166

167167
```bash
168168
copilot
169169

170-
> Review the book collection code for issues
170+
> Check the book collection code for quality issues
171171
```
172172

173173
**What happens behind the scenes**:
174-
1. Copilot sees "review" and "issues" in your prompt
175-
2. Checks skill descriptions, finds your `code-review` skill matches
174+
1. Copilot sees "code quality" and "issues" in your prompt
175+
2. Checks skill descriptions, finds your `code-checklist` skill matches
176176
3. Automatically loads your team's quality checklist
177177
4. Applies all checks without you listing them
178178

@@ -182,7 +182,7 @@ copilot
182182

183183
**Output**:
184184
```
185-
## Code Review: books.py
185+
## Code Checklist: books.py
186186
187187
### Code Quality
188188
- [PASS] All functions have type hints
@@ -300,14 +300,14 @@ Skills use a simple markdown format with YAML frontmatter:
300300

301301
```markdown
302302
---
303-
name: code-review
304-
description: Comprehensive code review with security, performance, and maintainability checks
303+
name: code-checklist
304+
description: Comprehensive code quality checklist with security, performance, and maintainability checks
305305
license: MIT
306306
---
307307

308-
# Code Review
308+
# Code Checklist
309309

310-
When reviewing code, check for:
310+
When checking code, look for:
311311

312312
## Security
313313
- SQL injection vulnerabilities
@@ -445,9 +445,9 @@ Skills and agents work together. The agent provides expertise, the skill provide
445445
# Start with a code-reviewer agent
446446
copilot --agent code-reviewer
447447

448-
> Review the book app for issues
448+
> Check the book app for quality issues
449449
# code-reviewer agent's expertise combines
450-
# with your code-review skill's checklist
450+
# with your code-checklist skill's checklist
451451
```
452452

453453
---
@@ -484,7 +484,7 @@ copilot
484484
Available skills:
485485
- security-audit: Security-focused code review checking OWASP Top 10
486486
- generate-tests: Generate comprehensive unit tests with edge cases
487-
- code-review: Team-standard code review checklist
487+
- code-checklist: Team code quality checklist
488488
...
489489

490490
> /skills info security-audit
@@ -561,10 +561,10 @@ If you find a skill in a GitHub repository, copy its folder into your skills dir
561561
git clone https://github.com/github/awesome-copilot.git /tmp/awesome-copilot
562562

563563
# Copy a specific skill to your project
564-
cp -r /tmp/awesome-copilot/skills/code-review .github/skills/
564+
cp -r /tmp/awesome-copilot/skills/code-checklist .github/skills/
565565

566566
# Or for personal use across all projects
567-
cp -r /tmp/awesome-copilot/skills/code-review ~/.copilot/skills/
567+
cp -r /tmp/awesome-copilot/skills/code-checklist ~/.copilot/skills/
568568
```
569569

570570
> ⚠️ **Review before installing**: Always read a skill's `SKILL.md` before copying it into your project. Skills control what Copilot does, and a malicious skill could instruct it to run harmful commands or modify code in unexpected ways.
@@ -812,7 +812,7 @@ Run `/skills reload` after creating or editing skills to ensure changes are pick
812812

813813
**Testing if a skill loads** - Ask Copilot directly:
814814
```bash
815-
> What skills do you have available for code review?
815+
> What skills do you have available for checking code quality?
816816
# Copilot will describe relevant skills it found
817817
```
818818

237 KB
Loading
575 KB
Loading

05-skills/images/skill-trigger-demo.tape

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Enter
2424
Sleep 5s
2525

2626
# Execute the prompt
27-
Type "Review the book collection code for issues"
27+
Type "Check the book collection code for quality issues"
2828
Sleep 2s
2929
Enter
3030

AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Beginner-friendly course teaching GitHub Copilot CLI. Educational content, not s
1010
| `samples/book-app-project/` | **Primary sample**: Python CLI book collection app used throughout all chapters |
1111
| `samples/book-app-buggy/` | **Intentional bugs** for debugging exercises (Ch 03) |
1212
| `samples/agents/` | Agent template examples (python-reviewer, pytest-helper, hello-world) |
13-
| `samples/skills/` | Skill template examples (code-review, pytest-gen, commit-message, hello-world) |
13+
| `samples/skills/` | Skill template examples (code-checklist, pytest-gen, commit-message, hello-world) |
1414
| `samples/mcp-configs/` | MCP server configuration examples |
1515
| `samples/buggy-code/` | **Optional extra**: Security-focused buggy code (JS and Python) |
1616
| `samples/src/` | **Optional extra**: Legacy JS/React samples from earlier course version |

samples/skills/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@ Ready-to-use skill templates for GitHub Copilot CLI. Copy any skill folder to st
99
cp -r hello-world ~/.copilot/skills/
1010

1111
# Or copy to your project for team sharing
12-
cp -r code-review .github/skills/
12+
cp -r code-checklist .github/skills/
1313
```
1414

1515
## Available Skills
1616

1717
| Skill | Description | Best For |
1818
|-------|-------------|----------|
1919
| `hello-world` | Minimal example (learning the format) | First-time skill creators |
20-
| `code-review` | Python code review checklist (PEP 8, type hints, validation) | Consistent code reviews |
20+
| `code-checklist` | Python code quality checklist (PEP 8, type hints, validation) | Consistent quality checks |
2121
| `pytest-gen` | Generate comprehensive pytest tests | Structured test generation |
2222
| `commit-message` | Conventional commit messages | Standardized git history |
2323

@@ -28,16 +28,16 @@ Skills are **automatically triggered** when your prompt matches the skill's `des
2828
```bash
2929
copilot
3030

31-
> Review this code for issues
32-
# Copilot detects this matches "code-review" skill and loads it automatically
31+
> Check this code for quality issues
32+
# Copilot detects this matches "code-checklist" skill and loads it automatically
3333

3434
> Generate a commit message
3535
# Copilot loads the "commit-message" skill
3636
```
3737

3838
You can also invoke skills directly:
3939
```bash
40-
> /code-review Check books.py
40+
> /code-checklist Check books.py
4141
> /pytest-gen Generate tests for BookCollection
4242
> /commit-message
4343
```
Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
name: code-review
3-
description: Team code review checklist - use for reviewing Python code quality, bugs, security issues, and best practices
2+
name: code-checklist
3+
description: Team code quality checklist - use for checking Python code quality, bugs, security issues, and best practices
44
---
55

6-
# Code Review Skill
6+
# Code Checklist Skill
77

8-
Apply this checklist when reviewing Python code.
8+
Apply this checklist when checking Python code.
99

1010
## Code Quality Checklist
1111

@@ -33,7 +33,7 @@ Apply this checklist when reviewing Python code.
3333
Present findings as:
3434

3535
```
36-
## Code Review: [filename]
36+
## Code Checklist: [filename]
3737
3838
### Code Quality
3939
- [PASS/FAIL] Description of finding

0 commit comments

Comments
 (0)