Skip to content

Commit 9f81e36

Browse files
authored
Merge pull request #2 from itk-dev/feature/add-github-workflow-skill
feat: add itk-dev-github workflow skill
2 parents 053ed4a + 2329e3f commit 9f81e36

3 files changed

Lines changed: 108 additions & 1 deletion

File tree

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ itkdev-claude-plugins/
1212
├── .mcp.json # MCP server configurations
1313
├── commands/ # Slash commands (Markdown files)
1414
│ └── example.md
15+
├── skills/ # Skills (Markdown files with frontmatter)
16+
│ └── itk-dev-github.md
1517
└── README.md
1618
```
1719

@@ -33,6 +35,16 @@ Team members can install the marketplace and plugins with:
3335

3436
Browser feedback collection tool from [mcp-claude-code-browser-feedback](https://github.com/itk-dev/mcp-claude-code-browser-feedback).
3537

38+
## Included Skills
39+
40+
### itk-dev-github
41+
42+
GitHub workflow guidelines for the ITK Dev team. Automatically activates when working with Git, branches, commits, or pull requests. Covers:
43+
- Branch naming conventions (`feature/issue-{number}-{description}`)
44+
- Conventional commit messages
45+
- Changelog updates (Keep a Changelog format)
46+
- PR requirements and templates
47+
3648
## Adding New Tools
3749

3850
### Adding MCP Servers
@@ -53,3 +65,18 @@ Edit `.mcp.json` to add new MCP server configurations:
5365
### Adding Commands
5466

5567
Create new Markdown files in the `commands/` directory. Each file becomes a slash command.
68+
69+
### Adding Skills
70+
71+
Create new Markdown files in the `skills/` directory with YAML frontmatter:
72+
73+
```markdown
74+
---
75+
name: skill-name
76+
description: When this skill should be activated automatically.
77+
---
78+
79+
# Skill Content
80+
81+
Your skill instructions here...
82+
```

commands/example.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Example Command
22

3-
This is an example slash command for the team-tools plugin.
3+
This is an example slash command for the itkdev-tools plugin.
44

55
## Usage
66

skills/itk-dev-github.md

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
---
2+
name: itk-dev-github
3+
description: GitHub workflow guidelines for itk-dev team. Use when working with Git, creating branches, making commits, opening pull requests, or any GitHub-related development tasks. Ensures compliance with team conventions for branching, commits, changelogs, and PR workflows.
4+
---
5+
6+
# itk-dev GitHub Workflow
7+
8+
## Core Rules
9+
10+
1. **Never commit directly to main** - All changes go through pull requests
11+
2. **Always create a feature branch** for every PR
12+
3. **Every PR must include** an updated CHANGELOG and reference related GitHub issues
13+
4. **Close related issues** upon PR merge using "Closes #XX" syntax
14+
15+
## Branch Naming
16+
17+
Format: `feature/issue-{number}-{short-description}`
18+
19+
Examples:
20+
- `feature/issue-123-add-user-authentication`
21+
- `feature/issue-45-fix-pagination-bug`
22+
- `feature/issue-78-update-api-endpoints`
23+
24+
## Commit Messages
25+
26+
Follow [Conventional Commits](https://www.conventionalcommits.org/):
27+
28+
```
29+
<type>: <description>
30+
31+
[optional body]
32+
33+
[optional footer]
34+
```
35+
36+
Types: `feat`, `fix`, `docs`, `style`, `refactor`, `test`, `chore`, `perf`, `ci`, `build`
37+
38+
Examples:
39+
- `feat: add language switcher component`
40+
- `fix: resolve pagination offset error`
41+
- `docs: update API documentation`
42+
- `refactor: extract validation logic to service`
43+
44+
## Changelog
45+
46+
Follow [Keep a Changelog](https://keepachangelog.com/) format. Update `CHANGELOG.md` with every PR under the `[Unreleased]` section.
47+
48+
Categories: `Added`, `Changed`, `Deprecated`, `Removed`, `Fixed`, `Security`
49+
50+
## Pull Request Requirements
51+
52+
### Before Opening PR
53+
- [ ] All GitHub Actions checks pass
54+
- [ ] CHANGELOG.md updated under `[Unreleased]`
55+
- [ ] Branch is up-to-date with main
56+
57+
### PR Description Template
58+
59+
```markdown
60+
## Summary
61+
Brief description of what this PR does and which issue it addresses (#XX).
62+
63+
## Features Added
64+
* Feature 1: Description
65+
* Feature 2: Description
66+
67+
## Files Changed
68+
* `path/to/file.ext` - What changed
69+
* `path/to/new-file.ext` (new) - Purpose
70+
71+
## Test Plan
72+
* Step-by-step verification instructions
73+
* Expected outcomes for each test
74+
75+
Closes #XX
76+
```
77+
78+
### Review Requirements
79+
- Minimum **one approving review** required before merge
80+
- All GitHub Actions checks must pass

0 commit comments

Comments
 (0)