Skip to content

Commit e822326

Browse files
committed
chore: update documentation and add contribution guidelines for agents, hooks, instructions, plugins, skills, and workflows; enhance actions-lock.json with additional actions
1 parent 44feaff commit e822326

12 files changed

Lines changed: 180 additions & 25 deletions

.github/aw/actions-lock.json

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,34 @@
11
{
22
"entries": {
3+
"actions/checkout@v6.0.2": {
4+
"repo": "actions/checkout",
5+
"version": "v6.0.2",
6+
"sha": "de0fac2e4500dabe0009e67214ff5f5447ce83dd"
7+
},
8+
"actions/download-artifact@v6": {
9+
"repo": "actions/download-artifact",
10+
"version": "v6",
11+
"sha": "018cc2cf5baa6db3ef3c5f8a56943fffe632ef53"
12+
},
313
"actions/github-script@v8": {
414
"repo": "actions/github-script",
515
"version": "v8",
616
"sha": "ed597411d8f924073f98dfc5c65a23a2325f34cd"
717
},
18+
"actions/upload-artifact@v6": {
19+
"repo": "actions/upload-artifact",
20+
"version": "v6",
21+
"sha": "b7c566a772e6b6bfb58ed0dc250532a479d7789f"
22+
},
823
"github/gh-aw/actions/setup@v0.45.7": {
924
"repo": "github/gh-aw/actions/setup",
1025
"version": "v0.45.7",
1126
"sha": "5d8900eb6f6230c9d41a3c30af320150a2361285"
27+
},
28+
"github/gh-aw/actions/setup@v0.46.1": {
29+
"repo": "github/gh-aw/actions/setup",
30+
"version": "v0.46.1",
31+
"sha": "874bdd8271bf8c21902b068fb1ca6a22d2dc4b7a"
1232
}
1333
}
1434
}

AGENTS.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -102,12 +102,10 @@ All agent files (`*.agent.md`), prompt files (`*.prompt.md`), and instruction fi
102102
- Each workflow is a standalone `.md` file in the `workflows/` directory
103103
- Must have `name` field (human-readable name)
104104
- Must have `description` field (wrapped in single quotes, not empty)
105-
- Should have `triggers` field (array of trigger types, e.g., `['schedule', 'issues']`)
106105
- Contains agentic workflow frontmatter (`on`, `permissions`, `safe-outputs`) and natural language instructions
107106
- File names should be lower case with words separated by hyphens
108107
- Only `.md` files are accepted — `.yml`, `.yaml`, and `.lock.yml` files are blocked by CI
109-
- Optionally includes `tags` field for categorization
110-
- Follow the [GitHub Agentic Workflows specification](https://github.github.com/gh-aw)
108+
- Follow the [GitHub Agentic Workflows specification](https://github.github.com/gh-aw/reference/workflow-structure/)
111109

112110
#### Plugin Folders (plugins/*)
113111
- Each plugin is a folder containing a `.github/plugin/plugin.json` file with metadata
@@ -140,7 +138,7 @@ When adding a new agent, prompt, instruction, skill, hook, workflow, or plugin:
140138

141139
**For Workflows:**
142140
1. Create a new `.md` file in `workflows/` with a descriptive name (e.g., `daily-issues-report.md`)
143-
2. Include frontmatter with `name`, `description`, `triggers`, plus agentic workflow fields (`on`, `permissions`, `safe-outputs`)
141+
2. Include frontmatter with `name` and `description`, plus agentic workflow fields (`on`, `permissions`, `safe-outputs`)
144142
3. Compile with `gh aw compile --validate` to verify it's valid
145143
4. Update the README.md by running: `npm run build`
146144
5. Verify the workflow appears in the generated README
@@ -266,13 +264,11 @@ For workflow files (workflows/*.md):
266264
- [ ] File has markdown front matter
267265
- [ ] Has `name` field with human-readable name
268266
- [ ] Has non-empty `description` field wrapped in single quotes
269-
- [ ] Has `triggers` array field listing workflow trigger types
270267
- [ ] File name is lower case with hyphens
271268
- [ ] Contains `on` and `permissions` in frontmatter
272269
- [ ] Workflow uses least-privilege permissions and safe outputs
273270
- [ ] No `.yml`, `.yaml`, or `.lock.yml` files included
274-
- [ ] Follows [GitHub Agentic Workflows specification](https://github.github.com/gh-aw)
275-
- [ ] Optionally includes `tags` array field for categorization
271+
- [ ] Follows [GitHub Agentic Workflows specification](https://github.github.com/gh-aw/reference/workflow-structure/)
276272

277273
For plugins (plugins/*/):
278274
- [ ] Directory contains a `.github/plugin/plugin.json` file

CONTRIBUTING.md

Lines changed: 69 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,25 @@
22

33
Thank you for your interest in contributing to the Awesome GitHub Copilot repository! We welcome contributions from the community to help expand our collection of custom instructions and prompts.
44

5+
## Table of Contents
6+
7+
- [How to Contribute](#how-to-contribute)
8+
- [Adding Instructions](#adding-instructions)
9+
- [Adding Prompts](#adding-prompts)
10+
- [Adding Agents](#adding-agents)
11+
- [Adding Skills](#adding-skills)
12+
- [Adding Plugins](#adding-plugins)
13+
- [Adding Hooks](#adding-hooks)
14+
- [Adding Agentic Workflows](#adding-agentic-workflows)
15+
- [Submitting Your Contribution](#submitting-your-contribution)
16+
- [What We Accept](#what-we-accept)
17+
- [What We Don't Accept](#what-we-dont-accept)
18+
- [Quality Guidelines](#quality-guidelines)
19+
- [Contributor Recognition](#contributor-recognition)
20+
- [Contribution Types](#contribution-types)
21+
- [Code of Conduct](#code-of-conduct)
22+
- [License](#license)
23+
524
## How to Contribute
625

726
### Adding Instructions
@@ -61,7 +80,7 @@ Your goal is to...
6180
- Include examples where helpful
6281
```
6382

64-
### Adding an Agent
83+
### Adding Agents
6584

6685
Agents are specialized configurations that transform GitHub Copilot Chat into domain-specific assistants or personas for particular development scenarios.
6786

@@ -161,25 +180,64 @@ plugins/my-plugin-id/
161180
- **Clear purpose**: The plugin should solve a specific problem or workflow
162181
- **Validate before submitting**: Run `npm run plugin:validate` to ensure your plugin is valid
163182

183+
### Adding Hooks
184+
185+
Hooks enable automated workflows triggered by specific events during GitHub Copilot coding agent sessions, such as session start, session end, user prompts, and tool usage.
186+
187+
1. **Create a new hook folder**: Add a new folder in the `hooks/` directory with a descriptive, lowercase name using hyphens (e.g., `session-logger`)
188+
2. **Create `README.md`**: Add a `README.md` file with frontmatter including `name`, `description`, and optionally `tags`
189+
3. **Create `hooks.json`**: Add a `hooks.json` file with hook configuration following the [GitHub Copilot hooks specification](https://docs.github.com/en/copilot/how-tos/use-copilot-agents/coding-agent/use-hooks)
190+
4. **Add bundled scripts**: Include any scripts or assets the hook needs, and make them executable (`chmod +x script.sh`)
191+
5. **Update the README**: Run `npm run build` to update the generated README tables
192+
193+
#### Example hook structure
194+
195+
```
196+
hooks/my-hook/
197+
├── README.md # Hook documentation with frontmatter
198+
├── hooks.json # Hook event configuration
199+
└── my-script.sh # Bundled script(s)
200+
```
201+
202+
#### Example README.md frontmatter
203+
204+
```markdown
205+
---
206+
name: 'My Hook Name'
207+
description: 'Brief description of what this hook does'
208+
tags: ['logging', 'automation']
209+
---
210+
211+
# My Hook Name
212+
213+
Detailed documentation about the hook...
214+
```
215+
216+
#### Hook Guidelines
217+
218+
- **Event configuration**: Define hook events in `hooks.json` — supported events include session start, session end, user prompts, and tool usage
219+
- **Executable scripts**: Ensure all bundled scripts are executable and referenced in both `README.md` and `hooks.json`
220+
- **Privacy aware**: Be mindful of what data your hook collects or logs
221+
- **Clear documentation**: Explain installation steps, configuration options, and what the hook does
222+
- Follow the [GitHub Copilot hooks specification](https://docs.github.com/en/copilot/how-tos/use-copilot-agents/coding-agent/use-hooks)
223+
164224
### Adding Agentic Workflows
165225

166226
[Agentic Workflows](https://github.github.com/gh-aw) are AI-powered repository automations that run coding agents in GitHub Actions. Defined in markdown with natural language instructions, they enable scheduled and event-triggered automation with built-in guardrails.
167227

168-
1. **Create your workflow file**: Add a new `.md` file in the `workflows/` directory (e.g., `daily-issues-report.md`)
169-
2. **Include frontmatter**: Add `name`, `description`, `triggers`, and optionally `tags` at the top, followed by agentic workflow frontmatter (`on`, `permissions`, `safe-outputs`) and natural language instructions
170-
3. **Test locally**: Compile with `gh aw compile --validate` to verify it's valid
171-
4. **Update the README**: Run `npm run build` to update the generated README tables
228+
1. **Create your workflow file** with a new `.md` file in the `workflows/` directory (e.g., [`daily-issues-report.md`](./workflows/daily-issues-report.md))
229+
2. **Include frontmatter** with `name` and `description`, followed by agentic workflow frontmatter (`on`, `permissions`, `safe-outputs`) and natural language instructions
230+
3. **Test locally** with `gh aw compile --validate --no-emit daily-issues-report.md` to verify it's valid
231+
4. **Update the README** with `npm run build` to update the generated README tables
172232

173233
> **Note:** Only `.md` files are accepted — do not include compiled `.lock.yml` or `.yml` files. CI will block them.
174234
175235
#### Workflow file example
176236

177237
```markdown
178238
---
179-
name: 'Daily Issues Report'
180-
description: 'Generates a daily summary of open issues and recent activity as a GitHub issue'
181-
triggers: ['schedule']
182-
tags: ['reporting', 'issues', 'automation']
239+
name: "Daily Issues Report"
240+
description: "Generates a daily summary of open issues and recent activity as a GitHub issue"
183241
on:
184242
schedule: daily on weekdays
185243
permissions:
@@ -294,7 +352,8 @@ In addition, all standard contribution types supported by [All Contributors](htt
294352

295353
## Code of Conduct
296354

297-
Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
355+
Please note that this project is maintained with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md).
356+
By participating in this project you agree to abide by its terms.
298357

299358
## License
300359

docs/README.agents.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
# 🤖 Custom Agents
22

33
Custom agents for GitHub Copilot, making it easy for users and organizations to "specialize" their Copilot coding agent (CCA) through simple file-based configuration.
4+
### How to Contribute
5+
6+
See [CONTRIBUTING.md](../CONTRIBUTING.md#adding-agents) for guidelines on how to contribute new agents, improve existing ones, and share your use cases.
7+
48
### How to Use Custom Agents
59

610
**To Install:**

docs/README.hooks.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
# 🪝 Hooks
22

33
Hooks enable automated workflows triggered by specific events during GitHub Copilot coding agent sessions, such as session start, session end, user prompts, and tool usage.
4+
### How to Contribute
5+
6+
See [CONTRIBUTING.md](../CONTRIBUTING.md#adding-hooks) for guidelines on how to contribute new hooks, improve existing ones, and share your use cases.
7+
48
### How to Use Hooks
59

610
**What's Included:**

docs/README.instructions.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
# 📋 Custom Instructions
22

33
Team and project-specific instructions to enhance GitHub Copilot's behavior for specific technologies and coding practices.
4+
### How to Contribute
5+
6+
See [CONTRIBUTING.md](../CONTRIBUTING.md#adding-instructions) for guidelines on how to contribute new instructions, improve existing ones, and share your use cases.
7+
48
### How to Use Custom Instructions
59

610
**To Install:**

docs/README.plugins.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
# 🔌 Plugins
22

33
Curated plugins of related prompts, agents, and skills organized around specific themes, workflows, or use cases. Plugins can be installed directly via GitHub Copilot CLI.
4+
### How to Contribute
5+
6+
See [CONTRIBUTING.md](../CONTRIBUTING.md#adding-plugins) for guidelines on how to contribute new plugins, improve existing ones, and share your use cases.
7+
48
### How to Use Plugins
59

610
**Browse Plugins:**

docs/README.prompts.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
# 🎯 Reusable Prompts
22

33
Ready-to-use prompt templates for specific development scenarios and tasks, defining prompt text with a specific mode, model, and available set of tools.
4+
### How to Contribute
5+
6+
See [CONTRIBUTING.md](../CONTRIBUTING.md#adding-prompts) for guidelines on how to contribute new prompts, improve existing ones, and share your use cases.
7+
48
### How to Use Reusable Prompts
59

610
**To Install:**

docs/README.skills.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
Agent Skills are self-contained folders with instructions and bundled resources that enhance AI capabilities for specialized tasks. Based on the [Agent Skills specification](https://agentskills.io/specification), each skill contains a `SKILL.md` file with detailed instructions that agents load on-demand.
44

55
Skills differ from other primitives by supporting bundled assets (scripts, code samples, reference data) that agents can utilize when performing specialized tasks.
6+
### How to Contribute
7+
8+
See [CONTRIBUTING.md](../CONTRIBUTING.md#adding-skills) for guidelines on how to contribute new agent skills, improve existing ones, and share your use cases.
9+
610
### How to Use Agent Skills
711

812
**What's Included:**

docs/README.workflows.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
# ⚡ Agentic Workflows
22

33
[Agentic Workflows](https://github.github.com/gh-aw) are AI-powered repository automations that run coding agents in GitHub Actions. Defined in markdown with natural language instructions, they enable event-triggered and scheduled automation with built-in guardrails and security-first design.
4+
### How to Contribute
5+
6+
See [CONTRIBUTING.md](../CONTRIBUTING.md#adding-agentic-workflows) for guidelines on how to contribute new workflows, improve existing ones, and share your use cases.
47

58
### How to Use Agentic Workflows
69

@@ -28,4 +31,6 @@
2831
- Respond to slash commands in issues and PRs
2932
- Orchestrate multi-step repository automation
3033

31-
_No entries found yet._
34+
| Name | Description | Triggers |
35+
| ---- | ----------- | -------- |
36+
| [Daily Issues Report](../workflows/daily-issues-report.md) | Generates a daily summary of open issues and recent activity as a GitHub issue | N/A |

0 commit comments

Comments
 (0)