docs: add CONTRIBUTING.md + PR template#5
Merged
Merged
Conversation
GitHub surfaces both during PR creation, so external contributors land on a guided path instead of having to read 109 lines of README first. README already covers the canonical "how to contribute" text; CONTRIBUTING.md is the short pointer + reviewer expectations, and the PR template is a fill-in checklist focused on the things maintainers care about (sign convention, manifest regen, hardware verification). No license, no CLA, no "thank-you-for-considering-our-project" fluff — the repo is community-first by design and the contributor shouldn't feel like they're submitting to a corporation. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Smooths the inbound contribution path for external driver PRs. README stays the canonical reference; these are the auto-surfaced GitHub touchpoints.
.github/CONTRIBUTING.md— short, points at the workbench (path A) and direct-PR (path B), enumerates what reviewers look for + what we don't require (no CLA)..github/PULL_REQUEST_TEMPLATE.md— fill-in checklist focused on device info, sign-convention verification, and manifest regen.Inspired by the two external PRs we got today (frekes81 + frahlg) — both worked but came with varying levels of context. This makes the path obvious.