<< All versions

Skill v1.0.0

currentAutomated scan100/100
josedowski/axioma/branch-pr
──Details
PublishedSeptember 27, 2026 at 11:29 AM
Content Hashsha256:d3776dbccdc8c8a3...
Git SHA
──Files
Files (1 file, 8.9 KB)
SKILL.md8.9 KBactive
SKILL.md · 315 lines · 8.9 KB

version: "1.0.0" name: gentle-ai-branch-pr description: "Create Gentle AI pull requests with issue-first checks. Trigger: creating, opening, or preparing PRs for review." license: Apache-2.0 metadata: author: gentleman-programming version: "2.0"


Gentle AI — Branch & PR Skill

When to Use

Load this skill whenever you need to:

Critical Rules

  1. Every PR MUST link an approved issue — Closes/Fixes/Resolves #<N> in the PR body, and that issue MUST have status:approved. PRs without this are automatically rejected by CI.
  2. Exactly one `type:*` label — apply exactly ONE type label to the PR. CI will reject PRs with zero or multiple type labels.
  3. 400-line review budget — keep PRs within 400 changed lines (additions + deletions) or request/obtain maintainer-applied size:exception with rationale documented.
  4. Automated checks must pass — see the Automated Checks table below.
  5. No `Co-Authored-By` trailers — never add AI attribution to commits.
  6. No force-push to main/master — protected branch.

Workflow

1. Confirm the issue has status:approved
gh issue view <N> --repo Gentleman-Programming/gentle-ai
2. Create a branch from main using the naming convention below
3. Implement changes following specs and design
4. Run checks locally (format + unit + E2E)
5. Commit using Conventional Commits format
6. Open a PR referencing the issue
→ Add exactly ONE type:* label
→ Fill in the PR body using the template
7. All automated checks must pass before merge

Branch Naming

Branch names must match this pattern:

^(feat|fix|chore|docs|style|refactor|perf|test|build|ci|revert)\/[a-z0-9._-]+$
TypeExample
feat/feat/user-login
fix/fix/duplicate-observation-insert
docs/docs/api-reference-update
refactor/refactor/extract-query-sanitizer
chore/chore/bump-bubbletea-v0.26
style/style/fix-linter-warnings
perf/perf/optimize-catalog-loading
test/test/add-pipeline-coverage
build/build/update-goreleaser-config
ci/ci/add-e2e-docker-job
revert/revert/undo-model-picker-change

Rules:

  • All lowercase
  • Use hyphens, dots, or underscores as separators (no spaces, no uppercase)
  • Description must be short and descriptive

PR Body Format

The PR body must follow the template at .github/PULL_REQUEST_TEMPLATE.md. All sections are required unless marked optional.

markdown
## 🔗 Linked Issue
Closes #<N>
## 🏷️ PR Type
-[ ] `type:bug` — Bug fix (non-breaking change that fixes an issue)
-[ ] `type:feature` — New feature (non-breaking change that adds functionality)
-[ ] `type:docs` — Documentation only
-[ ] `type:refactor` — Code refactoring (no functional changes)
-[ ] `type:chore` — Build, CI, or tooling changes
-[ ] `type:breaking-change` — Breaking change
## 📝 Summary
<!-- Clear description of what this PR does and why. -->
## 📂 Changes
| File / Area | What Changed |
|-------------|-------------|
| `path/to/file` | Brief description |
## 🧪 Test Plan
**Unit Tests**
\`\`\`bash
go test ./...
\`\`\`
**Go Format**
\`\`\`bash
go run ./internal/gofmtcheck
\`\`\`
**E2E Tests** (Docker required)
\`\`\`bash
cd e2e && ./docker-test.sh
\`\`\`
-[ ] Unit tests pass (`go test ./...`)
-[ ] Go format passes (`go run ./internal/gofmtcheck`)
-[ ] E2E tests pass (`cd e2e && ./docker-test.sh`)
-[ ] Manually tested locally
## ✅ Contributor Checklist
-[ ] PR is linked to an issue with `status:approved`
-[ ] PR stays within 400 changed lines, or I have requested/obtained maintainer-applied `size:exception` with rationale documented
-[ ] I have added the appropriate `type:*` label to this PR
-[ ] Unit tests pass (`go test ./...`)
-[ ] E2E tests pass (`cd e2e && ./docker-test.sh`)
-[ ] I have updated documentation if necessary
-[ ] My commits follow Conventional Commits format
-[ ] My commits do not include `Co-Authored-By` trailers

Automated Checks

These checks run on every PR and all must pass before merge:

CheckWhat It VerifiesHow to Fix
Check PR Cognitive LoadPR stays within 400 changed lines (additions + deletions) or has size:exceptionSplit the PR, or request/obtain maintainer-applied size:exception and document the rationale
Check Issue ReferencePR body contains Closes/Fixes/Resolves #NAdd Closes #<N> to the PR body
Check Issue Has `status:approved`Linked issue has been approved by a maintainerWait for maintainer to add status:approved to the issue
Check PR Has `type:*` LabelExactly one type:* label is applied to the PRAsk a maintainer to add the correct label; remove extras
Unit Testsgo test ./... passesFix failing tests before pushing
Go Formatgo run ./internal/gofmtcheck passesFormat malformed Go files before pushing
E2E Testscd e2e && ./docker-test.sh passesFix failing E2E scenarios before pushing

Conventional Commits

Commit messages must match this pattern:

^(build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test)(\([a-z0-9\._-]+\))?!?: .+

Format

<type>(<optional-scope>)!: <description>
[optional body]
[optional footer]

Allowed Types

TypePurposePR Label
featNew featuretype:feature
fixBug fixtype:bug
docsDocumentation onlytype:docs
refactorCode change (no behavior change)type:refactor
choreMaintenance, dependencies, toolingtype:chore
styleFormatting, linting (no logic change)type:chore
perfPerformance improvementtype:feature
testAdding or updating teststype:chore
buildBuild system or external depstype:chore
ciCI configurationtype:chore
revertReverts a previous commitmatches reverted type

Breaking Changes

Add ! after the type/scope:

feat(cli)!: rename --config flag to --config-file
BREAKING CHANGE: the --config flag has been renamed to --config-file.

Breaking changes map to type:breaking-change label.

Examples

feat(tui): add progress bar to installation steps
fix(agent): correct Claude Code detection on macOS
docs: update contributing guide
chore(deps): bump bubbletea to v0.26
refactor(pipeline): extract step executor
style: fix linter warnings in catalog package
perf(system): cache OS detection result
test(installer): add coverage for catalog step execution
build: update goreleaser config for arm64
ci: split unit and e2e test jobs
revert: undo model picker redesign
feat(cli)!: change default config path

Commands

Setup

bash
# Confirm issue is approved before starting
gh issue view <N> --repo Gentleman-Programming/gentle-ai
# Create branch
git checkout main && git pull
git checkout -b fix/<short-description>

Testing Locally

bash
# Unit tests
go test ./...
# Go format
go run ./internal/gofmtcheck
# Unit tests — specific package
go test ./internal/tui/...
# Unit tests — verbose
go test -v ./...
# E2E tests (Docker must be running)
cd e2e && ./docker-test.sh

Open a PR

bash
gh pr create \
--repo Gentleman-Programming/gentle-ai \
--title "fix(agent): correct Claude Code detection on Linux" \
--body "$(cat <<'EOF'
## 🔗 Linked Issue
Closes #42
## 🏷️ PR Type
- [x] \`type:bug\` — Bug fix (non-breaking change that fixes an issue)
## 📝 Summary
Fixes Claude Code binary detection failing on Linux when HOME is not set.
## 📂 Changes
| File / Area | What Changed |
|-------------|-------------|
| \`internal/agents/claude.go\` | Added HOME env var fallback |
## 🧪 Test Plan
- [x] Unit tests pass (\`go test ./...\`)
- [x] E2E tests pass (\`cd e2e && ./docker-test.sh\`)
- [x] Manually tested locally
## ✅ Contributor Checklist
- [x] PR is linked to an issue with \`status:approved\`
- [x] PR stays within 400 changed lines, or I have requested/obtained maintainer-applied \`size:exception\` with rationale documented
- [x] I have added the appropriate \`type:*\` label to this PR
- [x] Unit tests pass (\`go test ./...\`)
- [x] E2E tests pass (\`cd e2e && ./docker-test.sh\`)
- [x] I have updated documentation if necessary
- [x] My commits follow Conventional Commits format
- [x] My commits do not include \`Co-Authored-By\` trailers
EOF
)"

Check PR Status

bash
gh pr checks --repo Gentleman-Programming/gentle-ai <PR-number>
gh pr view --repo Gentleman-Programming/gentle-ai <PR-number>

Add a Label

bash
gh pr edit <PR-number> --repo Gentleman-Programming/gentle-ai --add-label "type:bug"
All versions