Skip to content

Commit 858a482

Browse files
committed
feat: add new skills for GitHub issue management and documentation generation
Signed-off-by: Felipe Sayão Lobato Abreu <github@mentordosnerds.com>
1 parent 6d5e8bd commit 858a482

File tree

13 files changed

+175
-227
lines changed

13 files changed

+175
-227
lines changed

.agents/skills/fast-forward-docs/SKILL.md

Lines changed: 4 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,10 @@
11
---
2-
name: fastforward-sphinx-docs
3-
description: Generate structured, consistent, and reusable Sphinx (reStructuredText) documentation for Fast Forward PHP framework libraries.
4-
version: 1.0.0
5-
tags:
6-
- documentation
7-
- sphinx
8-
- rst
9-
- php
10-
- fast-forward
11-
- technical-writing
12-
author: Fast Forward Ecosystem
13-
license: MIT
14-
inputs: []
15-
outputs:
16-
- type: documentation
17-
format: rst
2+
name: fast-forward-docs
3+
description: Generate or refresh Sphinx reStructuredText documentation for Fast Forward PHP packages. Use when Codex needs to create package docs in `docs/`, expand existing `.rst` sections, document APIs or workflows, or keep Fast Forward documentation structure consistent.
184
---
195

206

21-
# Sphinx Documentation Skill for Fast Forward Framework
7+
# Fast Forward Docs
228

239
This skill provides a comprehensive checklist and structure for generating rich, congruent, and reusable documentation in reStructuredText (.rst) for all libraries in the Fast Forward PHP framework ecosystem. Use these guidelines to ensure consistency, depth, and usability across all package docs.
2410

@@ -143,4 +129,4 @@ This skill provides a comprehensive checklist and structure for generating rich,
143129
- Integration with containers (PSR-11), service providers, and override/customization patterns.
144130
- Optional dependencies, version compatibility, and advanced troubleshooting scenarios.
145131
3. Always create or update sections to document any special scenario or advanced feature found in the codebase, mesmo que não esteja presente em outras libs.
146-
4. Follow the suggested structure, but add extra files/sections as needed to cover all the library's features and unique selling points.
132+
4. Follow the suggested structure, but add extra files/sections as needed to cover all the library's features and unique selling points.
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
interface:
2+
display_name: "Fast Forward Docs"
3+
short_description: "Generate Sphinx docs for Fast Forward packages"
4+
default_prompt: "Use $fast-forward-docs to generate or revise Sphinx documentation for this Fast Forward PHP package."

.agents/skills/fast-forward-docs/agents/openai.yml

Lines changed: 0 additions & 49 deletions
This file was deleted.

.agents/skills/fast-forward-github-issues/agents/openai.yml

Lines changed: 0 additions & 82 deletions
This file was deleted.
Lines changed: 138 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,138 @@
1+
---
2+
name: fast-forward-issues
3+
description: Transform a short feature, enhancement, or bug description into a complete production-ready GitHub issue with structured sections, acceptance criteria, and architectural quality requirements. Use when Codex needs to draft or refine an issue from a brief prompt.
4+
---
5+
6+
# Create GitHub Issue from Specification
7+
8+
This skill transforms a short feature description into a complete, production-ready GitHub issue written in clear, precise, and structured English following strict quality guidelines.
9+
10+
## When to Use This Skill
11+
12+
Use this skill when:
13+
- User provides a short feature description and asks to create a GitHub issue
14+
- User wants to transform a brief idea into a structured issue
15+
- User asks to "create issue from description" or similar
16+
- User provides a prompt describing a feature/enhancement/bug
17+
18+
## Input Processing
19+
20+
### Extract the Feature Description
21+
22+
The user will provide a short description. Extract and analyze:
23+
- The core request (add, enhance, fix, improve)
24+
- The subject/target of the request
25+
- Any specific tools, libraries, or technologies mentioned
26+
- The context or domain
27+
28+
### Infer Missing Details
29+
30+
Using engineering judgment, infer:
31+
- Common CLI patterns for the described feature type
32+
- Expected file locations and naming conventions
33+
- Standard architectural patterns for the feature domain
34+
- Typical acceptance criteria for similar features
35+
36+
## Output Generation
37+
38+
Generate a complete GitHub issue following this structure:
39+
40+
### 1. Title
41+
42+
- Clear, concise, descriptive
43+
- Action-oriented phrasing (Add, Enhance, Introduce, Fix)
44+
- Reflects intent and scope
45+
46+
### 2. Description
47+
48+
#### Problem
49+
- Explain current limitation or gap
50+
- Focus on real-world impact (DX, CI, maintenance, consistency)
51+
- Avoid fluff or generic statements
52+
53+
#### Proposal
54+
- Describe solution at conceptual level
55+
- Avoid jumping into implementation
56+
- Clearly state what will be introduced or changed
57+
58+
#### Goals
59+
- Define success criteria
60+
- Focus on outcomes, not implementation
61+
62+
#### Expected Behavior
63+
- Describe feature from user perspective
64+
- Include CLI examples when relevant
65+
66+
#### Implementation Strategy
67+
- Suggest practical approach
68+
- Mention tools, libraries, patterns when useful
69+
- Keep flexible, not prescriptive
70+
71+
#### Requirements
72+
- Define strict functional requirements
73+
- Must be testable and objective
74+
- Include CLI behavior, outputs, determinism, CI compatibility
75+
76+
#### Non-goals
77+
- Explicitly state what is out of scope
78+
- Prevent feature creep
79+
80+
#### Benefits
81+
- Explain why feature matters
82+
- Focus on developer experience, maintainability, consistency
83+
84+
#### Additional Context (optional)
85+
- Relevant background, ecosystem alignment, rationale
86+
87+
### 3. Acceptance Criteria
88+
89+
#### Functional Criteria
90+
- What must work
91+
- What must not break
92+
- Output expectations
93+
- Error handling expectations
94+
95+
#### Architectural/Isolation Criteria (MANDATORY)
96+
97+
Always include this section enforcing architectural quality:
98+
99+
```
100+
### Architectural / Isolation Criteria
101+
102+
- **MUST**: The core logic MUST be isolated into dedicated classes (no business logic inside the command/controller layer)
103+
- **MUST**: Responsibilities MUST be clearly separated:
104+
- One class for input/config resolution
105+
- One class for domain logic
106+
- One class for processing/transformations
107+
- One class for output/rendering
108+
- **MUST**: The command layer MUST act only as an orchestrator
109+
- **MUST**: The design MUST allow future extraction into an external reusable package with minimal changes
110+
- **MUST**: The implementation MUST avoid tight coupling to CLI/framework-specific I/O
111+
- **MUST**: The system MUST be extensible without requiring major refactoring
112+
```
113+
114+
## Style Guidelines
115+
116+
- Be highly objective and precise
117+
- Avoid filler language
118+
- Avoid vague statements like "improve things"
119+
- Prefer deterministic, testable statements
120+
- Use clean Markdown formatting
121+
- Use code blocks for CLI examples
122+
- Use bullet points for clarity
123+
- Keep strong engineering tone (not marketing, not casual)
124+
125+
## Output Format
126+
127+
Output the complete, ready-to-use GitHub issue in Markdown format. Do not include:
128+
- Follow-up questions
129+
- Explanations about the prompt
130+
- Meta commentary
131+
132+
## Example Transformation
133+
134+
**Input:**
135+
"Add a command to analyze dependencies using composer-unused and dependency-analyser"
136+
137+
**Output:**
138+
See the complete generated issue with all sections as specified above.
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
interface:
2+
display_name: "Fast Forward Issues"
3+
short_description: "Turn brief prompts into production-ready GitHub issues"
4+
default_prompt: "Use $fast-forward-issues to turn this repository idea into a complete GitHub issue with acceptance criteria."

.agents/skills/fast-forward-github-issues/SKILL.md renamed to .agents/skills/fast-forward-pull-request/SKILL.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
name: fast-forward-github-issues
3-
description: Iterates through all open GitHub issues in the repository and implements them one by one following a structured workflow. For each issue: creates a feature branch from main, implements the solution, creates or updates tests using fast-forward-tests, updates README with fast-forward-readme, updates docs with fast-forward-docs if applicable, and opens a pull request with Closes #<issue-number>. Triggers on requests like "implement issues", "work on issues", "handle all issues", "iterate through issues", "process issues", "implement all open issues".
2+
name: fast-forward-pull-request
3+
description: Implement open GitHub issues in a repository one by one with isolated branches, tests, documentation updates, and pull requests. Use when Codex is asked to work through issue queues, implement repository issues sequentially, or manage the full issue-to-PR flow in Fast Forward projects.
44
---
55

66
# Implement GitHub Issues
@@ -16,8 +16,8 @@ For each open issue:
1616
3. **Commits**: Create well-structured commits with clear messages
1717
4. **Tests**: Create or update tests using the `fast-forward-tests` skill
1818
5. **Documentation**: Update README using `fast-forward-readme`, update docs using `fast-forward-docs` if applicable
19-
6. **Pull Request**: Open a PR targeting `main` with `Closes #<issue-number>` in the description
20-
7. **Issue Handling**: Never close issues directly; only reference via `Closes #<issue-number>` in PR
19+
6. **Pull Request**: Open a PR targeting `main` with `Closes #123` style closing text in the description
20+
7. **Issue Handling**: Never close issues directly; only reference them via `Closes #123` style text in the PR
2121

2222
## Global Rules
2323

@@ -154,7 +154,7 @@ Create a pull request:
154154
Closes #{issue-number}
155155
```
156156

157-
**Important**: Include `Closes #<issue-number>` in the PR description so the issue is automatically closed only after the PR is merged.
157+
**Important**: Include `Closes #{issue-number}` in the PR description so the issue is automatically closed only after the PR is merged.
158158

159159
#### 2.10 Wait for Merge
160160

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
interface:
2+
display_name: "Fast Forward Pull Request"
3+
short_description: "Implement GitHub issues with tests, docs, and PR flow"
4+
default_prompt: "Use $fast-forward-pull-request to implement open GitHub issues one by one with branches, tests, docs, and pull requests."

.agents/skills/fast-forward-readme/SKILL.md

Lines changed: 4 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,9 @@
11
---
2-
name: fastforward-readme
3-
description: Generate high-quality, consistent, and discoverable README.md files for Fast Forward PHP framework components.
4-
version: 1.0.0
5-
tags:
6-
- documentation
7-
- readme
8-
- markdown
9-
- php
10-
- fast-forward
11-
- developer-experience
12-
author: Fast Forward Ecosystem
13-
license: MIT
14-
inputs: []
15-
outputs:
16-
- type: documentation
17-
format: markdown
2+
name: fast-forward-readme
3+
description: Generate or refresh README.md files for Fast Forward PHP packages. Use when Codex needs to create a new package README, reorganize an existing README, improve onboarding and discoverability, or align README structure with the Fast Forward ecosystem.
184
---
195

20-
# SKILL.md — Fast Forward Framework README Skill
6+
# Fast Forward README
217

228
## Purpose
239
This skill provides a comprehensive, reusable checklist and structure for creating high-quality, consistent, and discoverable `README.md` files for any component in the Fast Forward PHP framework ecosystem. It ensures:
@@ -266,4 +252,4 @@ This skill provides a comprehensive, reusable checklist and structure for creati
266252

267253
---
268254

269-
This skill is workspace-scoped and intended for maintainers and contributors of Fast Forward PHP libraries.
255+
This skill is workspace-scoped and intended for maintainers and contributors of Fast Forward PHP libraries.
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
interface:
2+
display_name: "Fast Forward README"
3+
short_description: "Generate consistent README files for Fast Forward packages"
4+
default_prompt: "Use $fast-forward-readme to write or refresh a README.md for this Fast Forward PHP package."

0 commit comments

Comments
 (0)