Github Issue Format logo

Github Issue Format

Community
richkuo
github-issue-format

Required format for creating or editing any GitHub issue — [C<score>] title convention, complexity rationale line, complete-body rule, mandatory Plain simple English section, attribution footer, milestone title rule. Load BEFORE creating or editing a GitHub issue or milestone.

Overview

Publisherrichkuo
Repositoryrk-skills
Skill namegithub-issue-format
Stars
50
Forks
8
Bundled files
Instructions only
LicenseMIT
Links
  • Markdown instructions

    A SKILL.md file the model loads on demand, so it only costs tokens when a request actually matches.

  • Works with any LLM

    AI skills are plain Markdown, not provider-specific code, so this works with GPT, Claude, Gemini, Grok, or a local model.

  • Self-contained

    Everything the model needs lives in the instructions — no extra files to sync.

  • Open source

    Published by richkuo on GitHub. Read the source before you install it.

Installation

Install the Github Issue Format AI skill in TypingMind to use it with any LLM, or drop it into another agent that reads SKILL.md.

1

Install in TypingMind

TypingMind installs a skill straight from its GitHub folder — it reads SKILL.md, bundles the resource files, and stores the result locally.

  1. Open the app and go to Plugins → Skills.
  2. Choose "Install from GitHub".
  3. Paste the skill folder URL below and confirm.
    https://github.com/richkuo/rk-skills/tree/main/skills/github-issue-format
  4. Enable the skill in any chat where you want it available.
Plugins → Skills → Add skill → From GitHub URL, then paste the folder URL and press Continue.
2

Install in another agent

Any agent that reads the Agent Skills format can use this skill — copy the folder into that agent's skills directory.

Claude Code — .claude/skills
git clone --depth 1 https://github.com/richkuo/rk-skills.git /tmp/rk-skills
mkdir -p .claude/skills
cp -r /tmp/rk-skills/skills/github-issue-format .claude/skills/github-issue-format
Restart Claude Code after copying so it picks up the new skill.

Use it in TypingMind

Enable Github Issue Format in any TypingMind chat and the model takes it from there. Its name and description sit in the system prompt, and the moment a request matches, the model loads the full instructions itself — you never invoke it by hand, and it costs no tokens until it is actually used.

The model loads Github Issue Format on its own as soon as a request matches it.

Works with any AI model

AI skills are plain Markdown instructions rather than provider-specific code, so Github Issue Format is not tied to the model it was written for. Install it once in TypingMind and use it with GPT-5, Claude, Gemini, Grok, DeepSeek, Mistral, Llama, or a local model you run yourself — all on your own API keys.

  • Loaded only when it is needed

    The system prompt carries just the name and description. The instructions are fetched on the first matching request, so an idle skill costs nothing.

  • Switch models mid-chat

    Because the skill is instructions rather than code, changing model does not break it — the next model reads the same SKILL.md.

Skill instructions

This is the SKILL.md content the model loads. Read it before installing — a skill is instructions your model will follow.

GitHub issue format

Title

  • [C<score>] <title>: a plain-simple-English sentence in ASD-STE100, precise about component and behavior, e.g. [C95] Orders can be filled twice when two fills arrive at the same moment.
  • The complexity score (0–100) is a model and effort routing signal. validate-issue step 6 owns the formula, axes, and routing table; never restate or approximate them here.

Milestone

  • Every milestone title you create or rename is one hyphenated token with no spaces (MCP-Read-foundations, Backtest-live-parity). This holds for every path that creates one: a batch from prd-to-issues, a split of one issue into follow-ups, or a manual request.
  • Before you assign an issue to a milestone that has spaces in its title, rename that milestone to the hyphenated form (gh api -X PATCH repos/<owner>/<repo>/milestones/<number> -f title=<new-title>). The rename keeps every issue on the milestone. Quote a title that still has spaces in every gh call.

Body

  • Never create a placeholder, stub, or empty-bodied issue. Every issue gets a complete body at creation, even in a batch. If a follow-up is not ready to spec, track it in the parent issue or notes until it is.
  • Section order: complexity rationale line, ## Problem, ## Goal, ## Approach, ## Acceptance criteria, ## Plain simple English, then any Execution block, then the attribution footer.
  • Complexity rationale line (first line of the body): matches the title prefix and ends with an explicit plan signal: **Complexity: 95/100** — Capability 3 (Risk 4, Uncertainty 2 — money/data-integrity on order-fill path); Volume 20 (Scope 4, Coupling 3, Verification 3) — Opus 5.5, high · plan: yes. The line always carries all five axis grades; the validate-issue scoring reference owns the axes and their anchors.
  • plan signal: · plan: yes when the score is ≥ 75 (a plan is posted before the build, by Opus 5.5 at xhigh when the score is ≥ 85 and at high below 85, unless a Plan model: Fable 5.1 stamp asks for Fable, whose plan runs only at high; the builder is Opus 5.5 at high); · plan: no below 75. Always write it. Compatibility (owned here): the signal and the Execution block key were once spelled · fableplan: yes|no and **fableplan first:**, and the PR-title suffix , fableplan. Every reader accepts both spellings, every writer emits only plan, and a restamp rewrites an old spelling to the new one. Fable 5.1 effort tiers follow the LLM Attribution Footer section of CLAUDE.md.
  • ## Plain simple English is mandatory on every issue: one short paragraph under 55 words in ASD-STE100, per the CLAUDE.md/AGENTS.md Response Style definition. State what is wrong or missing and why it matters, for a reader who knows the product but not the code. Never restate the approach, list file paths or symbols, or give a time or effort estimate there. An edit that rewrites body prose adds the section when it is missing; an edit that changes only machine metadata (the Execution block, the [C<score>] title prefix, or the complexity rationale line, as a rescore-only edit does) leaves every prose section unchanged and does not add it.
  • LLM Attribution Footer ends the body: Created for a new issue, Validated when a validation pass produced the edit (validate-issue and its wrappers), Updated for any other edit. Stack the new line under the existing ones; never replace them, and never append an exact duplicate of a line already there.
  • Project precedence: a repo CLAUDE.md issue or footer format overrides this default.

Frequently asked questions

What does the Github Issue Format AI skill do?

Required format for creating or editing any GitHub issue — [C<score>] title convention, complexity rationale line, complete-body rule, mandatory Plain simple English section, attribution footer, milestone title rule. Load BEFORE creating or editing a GitHub issue or milestone.

Why use Github Issue Format on TypingMind?

Because you install it once and use it with any model. Github Issue Format is plain Markdown rather than provider-specific code, so the same skill runs on GPT-5, Claude, Gemini, Grok, or a local model — and you can switch model mid-chat without it breaking. TypingMind runs on your own API keys, so you pay providers directly instead of a per-seat subscription, and your skills and chats stay in your own storage.

How do I install Github Issue Format in TypingMind?

Open Plugins → Skills → Install from GitHub in TypingMind and paste https://github.com/richkuo/rk-skills/tree/main/skills/github-issue-format. TypingMind reads its SKILL.md and installs it as a skill you can enable per chat.

Which AI models can use Github Issue Format?

Any model you connect in TypingMind. AI skills are plain Markdown instructions rather than provider-specific code, so GPT, Claude, Gemini, Grok, and local models can all load this skill when a request matches it.

How many AI models can I use with Github Issue Format?

As many as you like. As long as a model supports skills, you can use Github Issue Format with it — GPT, Claude, Gemini, Grok, DeepSeek, Mistral, Llama and more — all on TypingMind with your own API keys.

Is the Github Issue Format AI skill free?

Yes. It is published on GitHub by richkuo under the MIT license. You only pay your own AI provider for the tokens you use.

What are AI skills?

An AI skill is a reusable instruction bundle that teaches an AI model how to do one specific task. It follows the open Agent Skills format: a SKILL.md file with a name and description, plus any scripts, templates or reference files the model may need. The model reads the instructions only when your request matches the skill, so an installed skill costs nothing until it is used.

How are AI skills different from plugins or MCP servers?

A plugin or MCP server gives a model new tools to call — code that runs somewhere and returns a result. An AI skill gives the model knowledge and process instead: how to approach a task, which steps to follow, what good output looks like. Skills are plain Markdown, so they need no server, no API key and no runtime, and they work with any model.

View all

Set up your own AI workspace now

Get notified about new features and future giveaways by subscribing to our newsletter 👇