Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
<!-- Keep this short. A reader should know why this exists after one sentence. -->

**Why:**

<!-- One or two sentences: the problem a user or the project had. -->

**What:**

<!-- Two to five one-line bullets, plain language. Detail belongs in the linked issue. -->

-

Fixes #

## Type of Change

<!-- Check all that apply -->

- [ ] 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

<!-- Ensure all items are completed before requesting review -->

- [ ] 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
8 changes: 4 additions & 4 deletions .llm/context.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
29 changes: 16 additions & 13 deletions .llm/skills/ship-changes/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
<One sentence: what changed and why.>
**Why:** <The problem this PR solves. One or two plain sentences. Name what was
broken or missing and for whom. No implementation detail.>

## Behavior
<Up to two bullets.>
**What:**

## Validation
<Up to two bullets: tests run, captures.>
- <One-line bullet of an actual change.>
- <One-line bullet.>

## Risk / Rollback
<One line risk. One line revert plan.>
Fixes #<issue>
```

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
Expand Down
1 change: 0 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
1 change: 0 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,6 @@ nav:
- Organizing your data: organizing.md
- Extending the window: extending.md
- Troubleshooting: troubleshooting.md
- Troubleshooting: troubleshooting.md

validation:
nav:
Expand Down
Loading