Skip to content

Commit 6ecf19e

Browse files
committed
refactor!: rename templates/ to assets/ for skill-creator conformance
BREAKING CHANGE: The `templates/` directory has been renamed to `assets/` to follow skill-creator conventions. Update any references in your workflows or documentation. Changes: - Rename templates/ → assets/ directory (12 template files) - Rewrite SKILL.md with imperative/trigger-based style - Document all 5 references, 1 script, and 12 asset templates - Update internal path references in README.md and release-labeling.md
1 parent 10e1a08 commit 6ecf19e

15 files changed

Lines changed: 102 additions & 31 deletions

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -676,9 +676,9 @@ gh project create --title "Project Name"
676676
| `references/dependency-management.md` | Dependabot/Renovate and auto-merge patterns |
677677
| `references/sub-issues.md` | GitHub sub-issues GraphQL API |
678678
| `references/branch-migration.md` | Master to main migration guide |
679-
| `templates/auto-merge.yml.template` | Auto-merge with branch protection (--auto flag) |
680-
| `templates/auto-merge-queue.yml.template` | Auto-merge with merge queue (GraphQL mutation) |
681-
| `templates/auto-merge-direct.yml.template` | Auto-merge without branch protection |
679+
| `assets/auto-merge.yml.template` | Auto-merge with branch protection (--auto flag) |
680+
| `assets/auto-merge-queue.yml.template` | Auto-merge with merge queue (GraphQL mutation) |
681+
| `assets/auto-merge-direct.yml.template` | Auto-merge without branch protection |
682682
| `scripts/verify-github-project.sh` | Verification script for project setup |
683683

684684
## Related Skills

skills/github-project/SKILL.md

Lines changed: 97 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -5,45 +5,116 @@ description: "GitHub repository setup and configuration. This skill should be us
55

66
# GitHub Project Skill
77

8-
## Triggers
8+
GitHub repository setup, configuration, and best practices for collaboration workflows.
99

10-
- Creating a new GitHub repository
11-
- Configuring branch protection rules or rulesets
12-
- Setting up CODEOWNERS
13-
- Troubleshooting "merge is blocked" or "not allowed merge method" errors
14-
- Configuring auto-merge for Dependabot/Renovate
15-
- Setting up release workflows and release labeling
10+
## Core Workflow
1611

17-
## Usage
12+
To set up or configure a GitHub repository, follow these steps:
1813

19-
For workflows, CLI commands, templates, and troubleshooting guides, see `README.md`.
14+
1. Consult the appropriate reference for your task
15+
2. Copy and customize the relevant asset templates
16+
3. Run `scripts/verify-github-project.sh` to validate configuration
17+
4. Apply settings via GitHub UI or `gh` CLI
2018

21-
Key references:
22-
- `references/repository-structure.md` - Standard repo layout
23-
- `references/sub-issues.md` - Sub-issues GraphQL API
24-
- `references/dependency-management.md` - Dependabot/Renovate configuration
25-
- `references/release-labeling.md` - Automatic release labeling for PRs/issues
26-
- `templates/` - Auto-merge and release-labeler workflow templates
19+
## Using Reference Documentation
20+
21+
### Repository Setup
22+
23+
When setting up repository structure, consult `references/repository-structure.md` for standard file layout, required documentation files, and directory conventions.
24+
25+
When migrating from master to main branch, consult `references/branch-migration.md` for step-by-step migration commands and branch protection updates.
26+
27+
### Dependency Management
28+
29+
When configuring automated dependency updates, consult `references/dependency-management.md` for Dependabot and Renovate configuration patterns, auto-merge workflows, and update strategies.
30+
31+
### GitHub Features
32+
33+
When working with sub-issues, consult `references/sub-issues.md` for GraphQL API usage, parent-child relationships, and issue hierarchy patterns.
34+
35+
When setting up automatic release labeling, consult `references/release-labeling.md` for PR labeling workflows, release categorization, and changelog automation.
36+
37+
## Running Scripts
38+
39+
### Repository Verification
40+
41+
To verify GitHub project configuration against best practices:
42+
43+
```bash
44+
scripts/verify-github-project.sh /path/to/repository
45+
```
46+
47+
This script checks:
48+
- Repository documentation (README, LICENSE, SECURITY.md)
49+
- Collaboration setup (CODEOWNERS, issue/PR templates)
50+
- Dependency automation (Dependabot/Renovate, auto-merge)
51+
- Release configuration
52+
53+
## Using Asset Templates
54+
55+
### Repository Documentation
56+
57+
To set up CODEOWNERS for code review assignments, copy `assets/CODEOWNERS.template` to `.github/CODEOWNERS`.
58+
59+
To add contribution guidelines, copy `assets/CONTRIBUTING.md.template` to `CONTRIBUTING.md`.
60+
61+
To configure security vulnerability reporting, copy `assets/SECURITY.md.template` to `SECURITY.md`.
62+
63+
### Issue and PR Templates
64+
65+
To add a bug report template, copy `assets/bug_report.md.template` to `.github/ISSUE_TEMPLATE/bug_report.md`.
66+
67+
To add a feature request template, copy `assets/feature_request.md.template` to `.github/ISSUE_TEMPLATE/feature_request.md`.
68+
69+
To standardize PR descriptions, copy `assets/PULL_REQUEST_TEMPLATE.md.template` to `.github/PULL_REQUEST_TEMPLATE.md`.
70+
71+
### Dependency Automation
72+
73+
To configure Dependabot, copy `assets/dependabot.yml.template` to `.github/dependabot.yml`.
74+
75+
To configure Renovate, copy `assets/renovate.json.template` to `renovate.json`.
76+
77+
### Auto-Merge Workflows
78+
79+
To enable basic auto-merge for dependency updates, copy `assets/auto-merge.yml.template` to `.github/workflows/auto-merge.yml`.
80+
81+
To enable auto-merge with direct commits (no merge queue), copy `assets/auto-merge-direct.yml.template` to `.github/workflows/auto-merge.yml`.
82+
83+
To enable auto-merge with merge queue support, copy `assets/auto-merge-queue.yml.template` to `.github/workflows/auto-merge.yml`.
84+
85+
### Release Automation
86+
87+
To set up automatic release labeling for PRs, copy `assets/release-labeler.yml.template` to `.github/workflows/release-labeler.yml`.
2788

2889
## Go Project CI Checklist
2990

30-
For Go projects, ensure these GitHub configurations:
91+
When setting up CI for Go projects, ensure these GitHub configurations:
3192

3293
| Setting | Purpose | How |
3394
|---------|---------|-----|
3495
| Branch protection | Require tests pass before merge | Branch settings or Rulesets |
3596
| Dependabot/Renovate | Automated dependency updates | `.github/dependabot.yml` or `renovate.json` |
36-
| Auto-merge workflow | Merge minor/patch updates automatically | `templates/auto-merge*.yml` |
97+
| Auto-merge workflow | Merge minor/patch updates automatically | `assets/auto-merge*.yml` templates |
3798
| Required checks | CI workflow names in branch protection | Match exact workflow job names |
3899

39-
For CI/CD workflow content (test, lint, build), see `go-development` skill.
40-
For security workflows (Scorecard, CodeQL, SLSA), see `enterprise-readiness` skill.
41-
42100
## Related Skills
43101

44-
| Skill | Purpose |
45-
|-------|---------|
46-
| `go-development` | Go code patterns, Makefile interface, testing, linting |
47-
| `enterprise-readiness` | OpenSSF Scorecard, SLSA provenance, signed releases |
48-
| `git-workflow` | Git branching strategies, conventional commits |
49-
| `security-audit` | Deep security audits (OWASP, CVE analysis) |
102+
When implementing Go code patterns and CI/CD workflows, use the `go-development` skill.
103+
104+
When implementing OpenSSF Scorecard, SLSA provenance, or signed releases, use the `enterprise-readiness` skill.
105+
106+
When establishing Git branching strategies or conventional commits, use the `git-workflow` skill.
107+
108+
When conducting deep security audits (OWASP, CVE analysis), use the `security-audit` skill.
109+
110+
## External Resources
111+
112+
When understanding GitHub Actions syntax, consult the [GitHub Actions Documentation](https://docs.github.com/en/actions).
113+
114+
When configuring branch protection, consult the [GitHub Branch Protection Guide](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches).
115+
116+
When setting up Dependabot, consult the [Dependabot Documentation](https://docs.github.com/en/code-security/dependabot).
117+
118+
---
119+
120+
> **Contributing:** https://github.com/netresearch/github-project-skill
File renamed without changes.

skills/github-project/templates/CONTRIBUTING.md.template renamed to skills/github-project/assets/CONTRIBUTING.md.template

File renamed without changes.

skills/github-project/templates/PULL_REQUEST_TEMPLATE.md.template renamed to skills/github-project/assets/PULL_REQUEST_TEMPLATE.md.template

File renamed without changes.
File renamed without changes.

skills/github-project/templates/auto-merge-direct.yml.template renamed to skills/github-project/assets/auto-merge-direct.yml.template

File renamed without changes.

skills/github-project/templates/auto-merge-queue.yml.template renamed to skills/github-project/assets/auto-merge-queue.yml.template

File renamed without changes.

skills/github-project/templates/auto-merge.yml.template renamed to skills/github-project/assets/auto-merge.yml.template

File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)