Files
solidcraft/.github/pull_request_template.md
T
bherbruckandClaude Opus 5.5 52eb25311a Contributing: integration map, PR size, review and licence rules
ROADMAP.md gets an integration map near the top: which areas are open
for pull requests, which need an issue or RFC first, and which are
deferred until the CAD core is solid, with the milestone for each.

CONTRIBUTING.md gets a short "Before you start" section (integration
map, PR size, AI-assisted code, licences) and a "Review, CI and
milestones" part under "Sending a pull request". The PR template gets a
checklist.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-19 00:09:00 +00:00

2.0 KiB

Change

Describe the problem and resulting behavior. Link the issue when applicable.

Validation

What did you run, and what were the results? Include expected and measured values for geometry changes.

Screenshots of the behavior (when observable)

For observable CAD, UI or model behavior, include actual descriptive screenshots or a short recording from a small reproduction. This includes kernel, geometry, assembly and backend effects that can be shown in the app. Coding agents should run the app and capture the evidence themselves, rather than asking a human for evidence they can produce. Show the actual failure/result, preferably before and after, with brief steps, expected/actual behavior and annotations where helpful.

Flowcharts and Mermaid diagrams cannot substitute for evidence of visible behavior. Use diagrams for architectural reasoning when actual screenshots cannot illustrate the point. Changes with no useful observable behavior may omit screenshot/video evidence. Exclude private designs and sensitive details; attach media or link to an accessible recording rather than committing generated review artifacts.

Integration status

Record the upstream commit and PR status checked before handoff, any conflicts resolved, and validation after integration. Keep up with upstream merges and monitor this PR while the task is active; rebase before pushing and never force-push.

Checklist

  • The area is open on the integration map, or the approach was agreed in the linked issue.
  • Linked issue (Fixes #…), ideally one in a current milestone.
  • One topic, under about 1,000 changed lines (over about 2,000 only with an agreed issue).
  • Tests added or updated for the change.
  • No GPL/LGPL/AGPL code, dependencies or required programs; new dependencies are named above with their licence.
  • If AI tools helped, I have read and understood every line and can explain it.