Opening a PR in Unovis
Mirror the maintainers' real PRs: #821 Boxplot and #812 RadialBar.
Branch
- Branch off
main; never commit directly tomain. - Name it for the work, e.g.
feat/boxplot,fix/crosshair-threshold. - The F5 CLA bot comments on a first-time contributor's PR (sign the CLA when prompted). There
is no DCO /
Signed-off-byrequirement.
Commit grouping
Split the work into logical commits (see /commit for the message format). For a new component
the maintainers use this 4-commit grouping:
Component | <Name>: New component— thepackages/tscore (config, index, style, types, modules) plus its export wiring and registry entry.Dev | Examples: <Name> examples(orDev | Examples | <Name>: ...) — thepackages/devpages.Misc: Framework integrations— the regenerated wrappers across React/Angular/Svelte/Vue/Solid.Website: <Name> docs and gallery example— the.mdxdoc +packages/shared/examplesgallery entry + previews.
For smaller changes, one well-scoped commit is fine — keep core/dev/website/wrapper concerns in separate commits when they coexist.
PR title
- New component:
New Component: <Name> (<milestone>)— e.g.New Component: Boxplot (1.7). - Otherwise: a concise summary in the same
Type | Scope: Subjectspirit isn't required for the title, but keep it specific.
PR body
Use the maintainers' checklist template (tick what applies):
Adding a new `<Name>` <XY/Core/standalone> component
- [x] Dev examples
- [x] Wrappers
- [x] Gallery example
- [x] Docs
<!-- Light + dark screenshots and/or a short screen recording of the component -->
For non-component PRs, write a short summary of what changed and why, and keep a checklist of the surfaces touched (core / dev / docs / wrappers) when relevant.
Create the PR
git push -u origin <branch>
gh pr create --base main --title "New Component: <Name> (<milestone>)" --body "$(cat <<'EOF'
Adding a new `<Name>` XY component
- [x] Dev examples
- [x] Wrappers
- [x] Gallery example
- [x] Docs
EOF
)"
- Attach light and dark screenshots (and a short recording for interactive components). If you can't produce images, leave a placeholder line in the body and tell the user to drop them in.
- Before pushing, confirm
pnpm lintis clean and the build passes (CI runspnpm build && pnpm build:dev).