Skip to content

feat: add creating-github-issues skill#138

Closed
holstein13 wants to merge 2 commits intoobra:mainfrom
holstein13:add-creating-github-issues-skill
Closed

feat: add creating-github-issues skill#138
holstein13 wants to merge 2 commits intoobra:mainfrom
holstein13:add-creating-github-issues-skill

Conversation

@holstein13
Copy link

@holstein13 holstein13 commented Dec 2, 2025

Summary

  • Adds new skill for transforming problem descriptions into well-structured GitHub issues
  • Phase-based workflow: Clarify → Analyze → Options → Create → Submit
  • Issue type categorization (bug, feature, performance, architecture, security, docs)
  • Solution options presentation before committing to an approach
  • Comprehensive issue template ensuring actionable, testable issues

Change Type

  • feat: - New feature (MINOR: x.X.0)

Breaking Changes

N/A

Test Plan

  • Skill follows writing-skills guidelines (frontmatter, description format, sections)
  • Description starts with "Use when..." and is in third person
  • Includes Quick Reference table, Common Mistakes, Edge Cases
  • Word count within guidelines (~190 lines)

Context

This skill complements resolving-github-issues (PR #137) to provide a complete GitHub issue workflow:

Skill Purpose
creating-github-issues Problem → Issue (this PR)
resolving-github-issues Issue → Fix (PR #137)

Key features:

  1. Prevents vague issues - Mandatory clarification phase with type-specific questions
  2. Informed decisions - Codebase analysis before writing implementation details
  3. User choice - Present solution options before committing to approach
  4. Quality gate - Checklist ensures issues are self-contained, actionable, testable

Adapted from a battle-tested slash command used in production projects.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Added a comprehensive guide for creating well-structured GitHub issues: step-by-step workflow (Clarify, Analyze, Present, Create, Confirm), configurable templates and example issue bodies, quick-reference tables, questions by issue type, environment/metadata requirements, quality checklist, edge cases, common pitfalls, and an integration map with related skills.

✏️ Tip: You can customize this high-level summary in your review settings.

Systematic workflow for transforming problem descriptions into well-structured GitHub issues:
- Phase-based approach: Clarify → Analyze → Options → Create → Submit
- Categorization by issue type (bug, feature, performance, etc.)
- Solution options presentation before committing to approach
- Comprehensive issue template with all required sections
- Quality checklist ensuring issues are actionable and testable

Complements resolving-github-issues skill (opposite workflow).

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@coderabbitai
Copy link

coderabbitai bot commented Dec 2, 2025

Walkthrough

Adds a new documentation file describing a step-by-step workflow for turning user problem descriptions into well-structured GitHub issues, including phases, templates, questions per issue type, checklists, edge cases, and integration with related skills.

Changes

Cohort / File(s) Change Summary
GitHub Issues Skill Documentation
skills/creating-github-issues/SKILL.md
New documentation file detailing an end-to-end workflow (Clarify, Analyze Codebase, Present Solutions, Create Issue, Confirm/Submit), issue templates and example body, questions by issue type, environment/metadata requirements, quality checklist, edge cases, and related-skill integrations.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

  • Attention areas:
    • Accuracy and clarity of phase definitions and templates
    • Consistency with related skills (resolving-github-issues, brainstorming, writing-plans)
    • Completeness of question lists per issue type and environment/metadata fields

Poem

🐇 I nibble at text, tidy each line,
I shape a clear issue, neat and fine.
From clarify to submit, I hop and cheer,
Templates and checklists all appear.
A rabbit's small help for tracking what's dear.

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'feat: add creating-github-issues skill' clearly and directly summarizes the main change - adding a new skill documentation file for creating GitHub issues.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f9ade19 and 2a3d107.

📒 Files selected for processing (1)
  • skills/creating-github-issues/SKILL.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • skills/creating-github-issues/SKILL.md

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8462c20 and f9ade19.

📒 Files selected for processing (1)
  • skills/creating-github-issues/SKILL.md (1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
skills/creating-github-issues/SKILL.md

71-71: Fenced code blocks should have a language specified

(MD040, fenced-code-language)


160-160: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


164-164: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


168-168: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


172-172: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

🔇 Additional comments (1)
skills/creating-github-issues/SKILL.md (1)

1-193: Well-structured skill documentation with clear phase-based workflow.

The skill is well-organized and aligns with the PR objectives. The five-phase workflow (Clarify → Analyze → Options → Create → Submit) is clearly presented, the issue type categorization is practical, and the comprehensive template ensures issues are actionable and testable. The integration section correctly identifies complementary skills (resolving-github-issues, brainstorming, writing-plans).

The frontmatter and description follow guidelines (begins with "Use when...", uses third person), and the Common Mistakes and Edge Cases sections provide practical guidance for users of the skill.

- Add language identifier to fenced code block (line 71)
- Convert bold text to proper ### headings in Common Mistakes section

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@holstein13
Copy link
Author

@coderabbitai review

@coderabbitai
Copy link

coderabbitai bot commented Dec 2, 2025

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@nickolasclarke
Copy link

This has a lot of overlap with my open PR #121. It would be good for us to dig into the different shortcomings we are experiencing with github issue and project management, and consolidate, provided @obra ultimately agrees.

On a related note, I think this type of impasse going to come up quite a bit @obra, where someone has a skill they find particularly valuable for themselves, but for whatever does not make the cut for a generalized inclusion. Have you given any thought for a workflow that can be used to point at custom / private skills?

I like using superpowers as a single place to store such things, and ideally most, if not all, of the skills I develop would be able to be merged upstream. However, that may not always be true, and in any case there will be a lag between my PR being open and eventual merge. Currently, I am pointing my plugin marketplace installation at my fork, and then using gh repo sync to occasionally pull in any upstream changes. A bit jank, but this may be the best approach. Any other thoughts you've had on this subject? I am happy to break this convo into another thread elsewhere as well.

@obra
Copy link
Owner

obra commented Dec 24, 2025

Closing for the same reasons as the companion PR #137 - creating well-structured GitHub issues is something Claude handles naturally with gh issue create. The formal phases add structure but don't change behavior.

Thanks for contributing!

— Claude (in consultation with Jesse)

@obra obra closed this Dec 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants