name	pr
description	Create or update Cataclysm-BN PRs with validated titles, terse bodies, related links, and reviewer-useful evidence.
compatibility	git, gh, conventional-prs

PR

Use before gh pr create, gh pr edit, PR body edits, or PR title edits.

Sources

docs/en/contribute/changelog_guidelines.md
.github/semantic.yml
.github/pull_request_template.md
https://github.com/scarf005/conventional-prs

Title gate

Must pass conventional-prs --input '<title>'.
Use the smallest valid scope; do not invent scopes.
Required scopes: ports → port; Lua → lua; mods → mods or mods/<MOD_ID>; balance → balance; interface → UI.
For feat/fix, describe the visible player/reviewer impact, not implementation details.

Body gate

Read the diff, PR template, and existing PR body before writing or editing.
Search related issues/PRs. Also link known source PRs, commits, reports, or regressions even if search misses them.
Keep the body terse. Include only reviewer-useful context.
Purpose: state the bug/need and the relevant evidence. Paste the key log/screenshot/result snippet when it proves the issue.
Solution: concise bullets for what changed.
Testing: do not dump CI-equivalent command lists. State target/manual validations and results; include commands only when local-only, non-obvious, or useful for reproduction.
Preserve human content, artifacts, screenshots, checklist state, and generated artifact blocks when editing.
Remove irrelevant optional checklist items; keep applicable required/template items concrete.

Workflow

Inspect the diff and current branch status.
Read the PR template and current PR body if editing.
Run targeted gh search issues / gh search prs; inspect known source PRs from context or git log.
Draft the title and run conventional-prs --input '<title>'.
Draft or patch the body using the body gate.
Use explicit title/body arguments or --body-file; do not rely on unchecked --fill.

Repairs

feat: rebalancing some rifles → feat(balance): nerf jam chance of m16 and m4
fix: update vehicle cache invalidation → fix: update vehicle visibility after part changes
fix: UI bug → fix(UI): prevent item repair menu from hiding refittable items
Testing command dump → Added regression coverage for X; reproduced Y before the fix; confirmed Z after the fix.
Missing proof → include the one log line, screenshot, or before/after table that explains why the change exists.

Más de este repositorio

mismo repositorio

test-quality

cataclysmbn/Cataclysm-BN

Write or review Cataclysm-BN tests that avoid flakes, use deterministic fixtures, and clean up global state.

2026-06-121.1k

changelog-gen

cataclysmbn/Cataclysm-BN

Rewrite every `docs/*/game/changelog/{order}.stable-{semver}.md` from a ref range. Default `--limit=20`.

2026-05-301.1k

add-lua-binding-api

cataclysmbn/Cataclysm-BN

Add Cataclysm-BN Lua API bindings for global game functions, utility libraries, constants, callbacks, and domain-specific Lua namespaces.

2026-05-291.1k

add-lua-binding-complex

cataclysmbn/Cataclysm-BN

Add comprehensive Cataclysm-BN Lua bindings for complex C++ classes with methods, inheritance, constructors, properties, operators, and ownership rules.

2026-05-291.1k

add-lua-binding-simple

cataclysmbn/Cataclysm-BN

Add simple Cataclysm-BN Lua bindings for string_id types, enums, and basic read-only C++ types. Use when exposing straightforward C++ types to Lua.

2026-05-291.1k

deno-script

cataclysmbn/Cataclysm-BN

Write or modify Cataclysm-BN Deno/TypeScript scripts. Use for scripts, tools, migrations, generators, git hooks, and CLI utilities.

2026-05-291.1k

Use before gh pr create, gh pr edit, PR body edits, or PR title edits.

Sources

docs/en/contribute/changelog_guidelines.md

.github/semantic.yml

.github/pull_request_template.md

https://github.com/scarf005/conventional-prs

Title gate

Must pass conventional-prs --input '<title>'.

Use the smallest valid scope; do not invent scopes.

Required scopes: ports → port; Lua → lua; mods → mods or mods/<MOD_ID>; balance → balance; interface → UI.

For feat/fix, describe the visible player/reviewer impact, not implementation details.

Body gate

Read the diff, PR template, and existing PR body before writing or editing.

Search related issues/PRs. Also link known source PRs, commits, reports, or regressions even if search misses them.

Keep the body terse. Include only reviewer-useful context.

Purpose: state the bug/need and the relevant evidence. Paste the key log/screenshot/result snippet when it proves the issue.

Solution: concise bullets for what changed.

Testing: do not dump CI-equivalent command lists. State target/manual validations and results; include commands only when local-only, non-obvious, or useful for reproduction.

Preserve human content, artifacts, screenshots, checklist state, and generated artifact blocks when editing.

Remove irrelevant optional checklist items; keep applicable required/template items concrete.

Workflow

Inspect the diff and current branch status.

Read the PR template and current PR body if editing.

Run targeted gh search issues / gh search prs; inspect known source PRs from context or git log.

Draft the title and run conventional-prs --input '<title>'.

Draft or patch the body using the body gate.

Use explicit title/body arguments or --body-file; do not rely on unchecked --fill.

Repairs

feat: rebalancing some rifles → feat(balance): nerf jam chance of m16 and m4

fix: update vehicle cache invalidation → fix: update vehicle visibility after part changes

fix: UI bug → fix(UI): prevent item repair menu from hiding refittable items

Testing command dump → Added regression coverage for X; reproduced Y before the fix; confirmed Z after the fix.

Missing proof → include the one log line, screenshot, or before/after table that explains why the change exists.