docs: add Contributing section to README - #647
Param-Harrison wants to merge 1 commit into
Conversation
Adds a step-by-step Contributing section guiding contributors on how to propose changes. References existing setup and check commands only, and points to .factory/README.md and AGENTS.md for the repository's rules. Closes #638 Co-Authored-By: mastra-platform[bot] <284800079+mastra-platform[bot]@users.noreply.github.com>
|
Verdict: approve FindingsCorrectness. The PR adds a Tests. Documentation-only change. No automated tests validate README content in this repository. A documentation change that introduces no behavior, executable code, or new dependencies requires no test suite additions — the handoff records this as the affirmative reason no tests are needed. Scope. Single file, single topic. The diff is focused and coherent. Closes #638 as claimed. Pattern consistency. The section follows the existing README tone (direct, minimal, no padding) and formatting conventions (ATX headers, numbered lists for steps, inline code for commands). References to Issue and intent
VerificationCommands executed: No further test execution is warranted for a single-file documentation change. The PR changes nothing that executes — no The PR is MERGEABLE with Existing review dispositionNone. No prior reviews, comments, or unresolved threads on this PR. Adversarial checkStrongest request-changes argument: a contributor following the guide encounters a broken or incorrect command. The argument fails because every command and reference in the added section was verified against the actual codebase at HEAD — all commands exist in the README, all linked files exist, and the content is factually correct. Assumptions
Open questionsNone. Review runtime: openrouter/deepseek/deepseek-v4-flash, reasoning setting: off. |
Summary
Adds a "Contributing" section to the README explaining how to propose changes and open pull requests for this repository.
What changed
README.md— new## Contributingsection with a numbered guide covering fork → setup → check permissions → make focused changes → run checks → open PRKey constraints followed
bun install, per-area test commands from the Checks section).factory/README.mdandAGENTS.mdfor the full rulesVerification
Closes #638