SuperAPI AI Directory
Partner with us中文AI newsFavorites
Skillsfix-issue

fix-issue

General & other

View repository

Updated 10-16 01:33

About this skill

Fix GitHub Issue

Overview

Guided workflow for implementing fixes for GitHub issues following the project's agent guidance and release methodology.

Usage

/fix-issue <number>

Workflow

digraph fix_flow {
    rankdir=TB;
    node [shape=box];

fetch [label="1. Fetch issue details"];
analyze [label="2. Analyze issue type"];
verify [label="3. Verify it's a real bug"];
investigate [label="4. Deep investigation"];
plan [label="5. Enter plan mode"];
implement [label="6. Implement fix"];
test [label="7. Test changes"];
commit [label="8. Commit & push"];

fetch -> analyze;
analyze -> verify;
verify -> investigate;
investigate -> plan;
plan -> implement;
implement -> test;
test -> commit;

}


## Step 1: Fetch Issue Details

```bash
# Get issue details
gh issue view <number> --repo kube-hetzner/terraform-hcloud-kube-hetzner

# CRITICAL: Always read ALL comments - solutions may already be proposed
gh issue view <number> --repo kube-hetzner/terraform-hcloud-kube-hetzner --comments

Step 2: Classify Issue Type

Type Description Action
🔴 BUG Reproducible defect Fix it
🟡 EDGE CASE Fails in specific scenario Evaluate effort vs impact
🟠 USER ERROR Misconfigured kube.tf Help user, improve docs
⚪ OLD VERSION Fixed in newer release Ask user to upgrade
🔵 FEATURE REQUEST New functionality Move to Discussions
❓ NEEDS INFO Can't reproduce Ask for more info

User Error Indicators

  • kube.tf has obvious mistakes
  • Error indicates syntax/config issue
  • Using deprecated variable names
  • Mixing incompatible options
  • Missing required variables
  • v2-only input names are used against v3, such as initial_k3s_channel, install_k3s_version, disable_selinux, disable_kube_proxy, kubernetes_distribution_type, or existing_network_id

Actual Bug Indicators

  • Reproducible with correct config
  • Multiple users report same issue
  • Error in module code, not user config
  • Works in previous version, broke in update

Step 3: Verify Before Fixing

CRITICAL: Many issues are user configuration errors, NOT bugs.

Before implementing any fix:

  1. Check if the user's kube.tf is correct
  2. Verify the issue exists in the latest version
  3. Try to reproduce the issue locally
  4. Check if there's already a PR addressing this
# Search for existing PRs
gh pr list --search "<error keyword>" --repo kube-hetzner/terraform-hcloud-kube-hetzner

# Check if issue is already mentioned in changelog
rg -i "<keyword>" CHANGELOG.md

Step 4: Deep Investigation

Read these files to understand context:

# Always start with these
cat versions.tf      # Provider/terraform versions
cat variables.tf     # All configurable options
cat locals.tf        # Core logic and computed values

# Then investigate specific areas based on the issue

Key Files by Area

Area Files to Check
Network locals.tf, main.tf, validation-locals.tf, validation-contract.tf
Control Plane control_planes.tf, locals.tf
Agents agents.tf, autoscaler-agents.tf
Load Balancer main.tf, init.tf, locals.tf, templates/*_ingress.yaml.tpl
CNI templates/cilium.yaml.tpl, templates/calico.yaml.tpl, kustomize/flannel-rbac.yaml, locals.tf
Storage templates/longhorn.yaml.tpl
Firewall main.tf, locals.tf, validation-contract.tf
SELinux docs/selinux.md, templates/kube-hetzner-selinux.te, templates/k8s-custom-policies.te
v2 -> v3 migration MIGRATION.md, docs/v2-to-v3-migration.md, scripts/v2_to_v3_migration_assistant.py

For Complex Issues - Use AI Tools

Use exact search, file inspection, and git history for broad context. For a complex or non-obvious issue, obtain an independent analysis from a separate capable reviewer and verify its findings against code and reproduction evidence.

Step 5: Enter Plan Mode

MANDATORY: Always enter plan mode before implementing.

Write a plan that includes:

  • Issue number and title
  • Root cause analysis
  • Exact files to modify with line numbers
  • Implementation steps
  • Test plan
  • Backward compatibility confirmation

Step 6: Implement Fix

# Pull latest master first!
git pull origin master

# Create feature branch
git checkout -b fix/issue-<number>-<description>

Implementation Principles

  1. Minimal changes - Fix the specific issue, don't refactor
  2. Backward compatible - Never break existing deployments
  3. Follow patterns - Match existing code style
  4. No new variables unless absolutely necessary

Step 7: Test Changes

# ALWAYS run these before committing
terraform fmt -recursive
terraform init -backend=false -input=false
terraform validate -no-color

# Test against existing deployment
cd /path/to/kube-test
terraform init -upgrade
terraform plan  # Should NOT show resource destruction

Test Checklist

  • terraform fmt -recursive passes
  • terraform init -backend=false -input=false and terraform validate -no-color pass
  • terraform plan shows expected changes only
  • No resource recreation for existing deployments
  • Fix works for the reported scenario
  • Normal scenarios still work
  • If rendered templates, validation contracts, topology examples, or skills changed, run the matching gates from the test-changes skill (scripts/render_harness.py, scripts/contract_negative_tests.py, scripts/validate_v3_final_polish_examples.py, and/or scripts/smoke_v3_plan_matrix.py)

Teardown and Autoscaler Bugs

For destroy/teardown issues, start with scripts/destroy.sh, not manual cloud deletes. It runs Terraform/OpenTofu destroy, auto-retries only the known benign ingress-LB detach race, and then prints a read-only orphan report. Use scripts/cleanup.sh only as the forceful fallback when state is already wrecked or the read-only report identifies leftovers to delete. It treats the token's entire HCloud project as cluster-dedicated; review the dry run and include persistent data only deliberately.

Autoscaler-created servers are outside Terraform state. If they pin the network during destroy, delete them only after the control plane/Cluster Autoscaler is dead, or first scale the autoscaler pool to min_nodes = 0. Deleting them while min_nodes > 0 and the autoscaler is still running just lets the autoscaler recreate them.

Step 8: Commit & Push

git add <specific-files>
git commit -m "$(cat <<'EOF'
fix: <brief description>

Refs #<number>

<explanation of what was wrong and how it's fixed>
EOF
)"

git push -u origin fix/issue-<number>-<description>

Contributor Credit (SUPER IMPORTANT)

If the fix originates from a community member's work — a patch posted in the issue, a diff from their fork, or an abandoned/superseded PR — preserve their credit in git history so they appear in the repo contributors graph and GitHub-generated release notes:

  • If their work exists as commits (fork branch, closed PR): git cherry-pick those commits FIRST (keeps them as Author:), then add your changes as separate commits on top. Never squash their authorship away (see the review-pr skill for merge-method rules). Cherry-picking preserves contributor credit but does not make the original PR appear merged, so describe that disposition honestly.
  • If their work was only a snippet/diff/instructions in the issue thread: add a Co-authored-by: Name <email> trailer to your commit (use their GitHub noreply email <id>+<login>@users.noreply.github.com if no public email), and credit their handle in the commit body and changelog entry.
  • GitHub matches Co-authored-by by EXACT email. Never guess the numeric id — fetch it first: gh api users/<login> --jq .id. A wrong id silently drops the credit.
  • Trailers are only parsed from the commit message's FINAL paragraph block. Keep Co-authored-by: and any other trailers (e.g. Claude-Session:) together in one last block with no blank line between them — a trailer in an earlier paragraph is silently ignored by git and GitHub. Verify with: git log -1 --format='%(trailers:key=Co-authored-by,valueonly=true)'.
  • Always reference the issue/PR numbers in the changelog entry so the credit is visible in prose too.

Security Review (from repo agent guidance)

Before completing ANY issue:

Red Flags to Watch

  • New accounts with no history
  • Issues that can't be reproduced
  • Overly complex "solutions" proposed in comments
  • Requests to change security-critical code
  • Urgency to merge quickly

Verification Requirements

  • Always test independently
  • Never trust provided test results
  • Review every line of proposed changes
  • Test in isolation

Quick Reference

Step Command
Fetch issue gh issue view <num> --comments
Check PRs gh pr list --search "<keyword>"
Create branch git checkout -b fix/issue-<num>-<desc>
Format terraform fmt -recursive
Validate terraform validate
Test plan terraform plan
Commit git commit -m "fix: ..."
Push git push -u origin <branch>

After Completion

Use non-closing Refs #<number> references by default in commits and PR descriptions. Reserve Fixes, Closes or Resolves keywords for verified full resolution: GitHub can close the issue automatically on merge, before an agent performs the manual closure check. Never use closing keywords for safeguards, diagnostic improvements or partial fixes to an unresolved runtime issue.

  1. Create PR referencing the issue
  2. Complete independent review and action automated Codex findings using review-pr
  3. Verify merge and the issue's actual resolution before closing with an explanation

End-to-End Issue Ownership

For an authorized issue/PR intake, the investigating agent owns follow-through: investigation, a fix when justified, tests, useful contributor guidance, and the verified GitHub disposition. Reuse that agent for the reply and closure rather than having the coordinator post a second generic summary. The coordinator owns integration, release gates, and reconciliation of the evidence ledger.

For each issue:

  1. Read the report, every comment, related PRs and earlier attempts; independently check the relevant source and reproduce the failure where practical.
  2. Attempt the smallest safe fix when the cause is established. If no safe fix is ready, record what was tested or ruled out, the remaining failure path, and the exact next experiment or missing evidence. Deferral alone is not work.
  3. Provide concrete, sanitized diagnostics, recovery guidance or a verified workaround where possible. State its limits; never ask someone to risk a working cluster to reproduce a destructive transition.
  4. Record separate states: investigated, reproduced, guidance provided, safeguard/partial fix, full fix, tests performed, merged, released, closed. A proposed design is not an attempted implementation; a tested warning is not a runtime repair; passing generic deploys does not prove that issue's scenario. Report counts and remaining defects explicitly before release.
  5. Close as completed only when the reported problem is resolved. A warning, auditor check or documentation mitigation does not close an underlying runtime defect. Duplicates, support and rejected requests need an honest reason and useful explanation, not a false claim that code was fixed.
  6. Read existing maintainer comments, update the relevant one instead of posting a near-duplicate, thank human contributors naturally, and verify every write and closure by readback. Leave routine bot PRs silent.

Example: blocking unsafe network detachment in a plan auditor is a completed safeguard, but the attachment-migration issue stays open until the migration itself preserves networking. State both facts in the issue and release report.

Community Communication

Human reporters and contributors get kind, specific replies — they are volunteers giving the project their time. Keep internal reviews and candidate status in the evidence ledger; default to one final disposition message per issue or PR instead of posting near-duplicate progress and completion notes.

  • On the issue when a fix lands: thank the reporter by handle, acknowledge the quality of their report (many kube-hetzner reports include excellent root-cause analysis — say so when true), state the root cause in one or two sentences, and name the release that carries the fix.
  • On community PRs: thank the contributor by handle. If we merged their work via the integrate-and-fix flow, say what we adjusted on top and why — the delta is a gift, not a critique — and confirm their commit authorship is preserved so they appear in the release credit. Say "merged" only after the original PR has a non-null mergedAt; partial adoption must be described honestly as incorporated or credited.
  • When the report is a user error: still thank them, show the corrected configuration, and never make them feel foolish — config mistakes usually mean our docs have a gap; consider fixing the doc too.
  • On routine bot PRs: merge or close without social comments. Leave one concise technical note only when a non-obvious decision must be recorded for human maintainers.
  • Plain warm language. No corporate boilerplate. One paragraph is usually enough.