skills.rest
dotBeeps
dotBeepsCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

github-writing

Draft GitHub documents with outline approval before writing files.

Updated Mar 31, 2026
Search Tags:#templates#writing#github#readme#contributing#pr#release-notes
One-click install
npx skills add https://github.com/dotBeeps/hoard --skill github-writing
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: github-writing
Source: https://github.com/dotBeeps/hoard/tree/main/morsels/skills/github-writing
Command: npx skills add https://github.com/dotBeeps/hoard --skill github-writing

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Many repository-facing documents are inconsistent, incomplete, or missing crucial context for reviewers and contributors. This skill removes friction by guiding document classification, collecting minimal context, and producing style-consistent PRs, issues, README sections, contributing guides, release notes, and repository templates that reviewers can act on immediately.

Core Features & Use Cases

  • Structured workflow: Classify the document type, run a short interview to gather goals and audience, perform read-only repository research, and present an outline for approval before drafting.
  • Style and attribution: Resolve and apply repository tone settings, enforce style guardrails, and append transparent AI contributor attribution when requested.
  • Safe publishing flow: Draft in GitHub Flavored Markdown, request final approval, and withhold any CLI or file-writing actions (like gh or git commands) until the user explicitly approves them.

Quick Start

Draft a PR description summarizing the changes in branch feature/login-fix, link the motivating issue, list testing steps, and apply the friendly style.

Frequently Asked Questions about github-writing

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write a clear PR description for GitHub code reviews?▼

To write a clear PR description, this Skill classifies the request, gathers context through a short interview, and drafts a reviewer-ready document in GitHub Flavored Markdown. It presents an outline for your approval before generating the final text.

What is the best way to generate release notes for a repository?▼

Generating release notes involves performing read-only repository research to identify changes, applying style guardrails, and drafting structured notes. This Skill creates an outline first, ensuring the release notes capture accurate context before final approval.

Can I use this to draft a contributing guide and README for my GitHub project?▼

Yes, you can use this to draft contributing guides and READMEs. It performs document classification, conducts a concise interview to understand your audience, and produces style-consistent repository templates ready for immediate review.

Does this Skill automatically write files or run git commands to publish issues?▼

No, this Skill does not automatically write files or run git commands. It withholds all CLI or file-writing actions until you explicitly approve them, ensuring a safe publishing flow where you maintain full control over repository changes.

Related Skills

Explore More Software Engineering Skills→
cgRGMcgRGM
1

product-marketing

Create and update product marketing context documents from repository materials.

Community
Advanced
typemdtypemd
9

create-release

Gather closed issues and commits to draft release notes and create a GitHub draft release.

Official
Advanced
zMynxxzMynxx

issue-creation

Create structured GitHub issues with templates and approval workflows.

Community
Intermediate
rudironsonirudironsoni

dotnet-github-docs

Generates READMEs, CONTRIBUTING guides, and issue/PR templates for .NET projects.

Community
Intermediate