diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..1c0e032 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,32 @@ + + +**Why:** + + + +**What:** + + + +- + +Fixes # + +## Type of Change + + + +- [ ] Bug fix (non-breaking change that fixes an issue) +- [ ] New feature (non-breaking change that adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to change) +- [ ] Documentation update +- [ ] Refactor (code change that neither fixes a bug nor adds a feature) + +## Checklist + + + +- [ ] I have added tests that prove my fix is effective or my feature works +- [ ] I have updated the documentation accordingly +- [ ] I have updated the [CHANGELOG](../CHANGELOG.md) for user-facing changes +- [ ] My changes do not introduce breaking changes, or breaking changes are documented diff --git a/.llm/context.md b/.llm/context.md index 56c04fa..b144c31 100644 --- a/.llm/context.md +++ b/.llm/context.md @@ -262,10 +262,10 @@ pre-commit config on staged `.cs` files. PR body. - Short imperative subjects with the subsystem up front (for example "Fix settings persistence dirty state"); reference related issue IDs in the body. -- Keep PR bodies scannable: one-sentence summary of what and why, then the - template in `ship-changes` (Behavior, Validation, Risk/Rollback), at most two - bullets per section, 15 lines total. No paragraphs, history, or diff narration; - details live in commits, tests, and issues. Add screenshots or GIFs for UI tweaks. +- Lead PR bodies with the problem: `**Why:**` states the defect or need in user + terms, `**What:**` lists one-line change bullets, then `Fixes`/`Refs` lines + (template in `ship-changes`). Cap 15 lines; no headers beyond Why/What, no + validation transcripts or risk essays; details live in commits, tests, issues. - Confirm CSharpier formatting, `npm pack`, and both Unity test suites before requesting review. - Version bumps: change `package.json`, then run `npm run lint:llm:fix` so the diff --git a/.llm/skills/ship-changes/SKILL.md b/.llm/skills/ship-changes/SKILL.md index 7e30efd..9a0f6b5 100644 --- a/.llm/skills/ship-changes/SKILL.md +++ b/.llm/skills/ship-changes/SKILL.md @@ -52,28 +52,31 @@ Run the narrowest sufficient layer; escalate on failure: ## Pull Requests -Use this body shape. Confirm CSharpier, `npm pack`, and both Unity test suites -before handoff. +GitHub pre-fills the body from `.github/pull_request_template.md` (Why/What + +Type of Change + Checklist); keep that shape. Confirm CSharpier, `npm pack`, +and both Unity test suites before handoff. ```markdown - +**Why:** -## Behavior - +**What:** -## Validation - +- +- -## Risk / Rollback - +Fixes # ``` Rules (see `.llm/context.md`): -- Body stays under 15 lines. Every section: bullets, not paragraphs. -- No history, no diff narration, no "this PR", no restating commits. -- Details live in commits, tests, and issues; link to them, do not paste. -- UI tweaks add one screenshot or GIF under Validation. +- Body narrative stays under 15 lines; every bullet is one line. +- No Behavior/Validation/Risk headers, no validation transcripts, no risk or + rollback essays, no history, no diff narration, no "this PR". The template's + Type of Change and Checklist sections are the only allowed headers. +- Validation evidence, limitations, and risk go in the commit body, tests, and + issues; link to them, do not paste them. +- UI tweaks add one screenshot or GIF after the bullets. Never explicitly request a review from a person, team, bot, or automation. Do not mention a reviewer in a comment, call a reviewer-request API, or otherwise trigger a diff --git a/docs/index.md b/docs/index.md index 8f47b08..72536b3 100644 --- a/docs/index.md +++ b/docs/index.md @@ -53,7 +53,6 @@ Open the window with **Tools → Wallstop Studios → Data Visualizer**. - [Organizing your data](organizing.md) — ordering, layout, themes, persistence, and Play Mode. - [Extending the window](extending.md) — attributes, `BaseDataObject`, processors, and custom inspector content. - [Troubleshooting](troubleshooting.md) — slow loading, stale views, missing assets, window size limits, and capture regeneration. -- [Troubleshooting](troubleshooting.md) — what slow loading, stale views, missing assets, and small windows mean, plus the capture pipeline's limits. - [README](https://github.com/wallstop/DataVisualizer#readme) — the repository README, which links the video walkthrough. - [Video walkthrough](https://youtu.be/3oUxUSKNyhw) — a visual tour of the window. - [Issues](https://github.com/wallstop/DataVisualizer/issues) — known problems and feature requests. diff --git a/mkdocs.yml b/mkdocs.yml index 56c4c98..ab544b3 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -49,7 +49,6 @@ nav: - Organizing your data: organizing.md - Extending the window: extending.md - Troubleshooting: troubleshooting.md - - Troubleshooting: troubleshooting.md validation: nav: