Add contributor workflow and templates - #137
Conversation
ReviewOverall this is a thorough, well-scoped PR that follows the repository's existing conventions closely: SHA-pinned actions, fail-closed policy checkers with negative-path unit tests, navigation-guide/README/CHANGELOG kept in sync, and a Rust conformance test binding the new docs/CI/templates together. Nice work. Code quality / design
Minor findings
SecurityNo concerns. The checker only reads fixed repository-relative paths, the private-vulnerability route is hardcoded to the correct advisory URL, and the new GitHub Actions step uses a SHA-pinned Test coverageGood — 9 Python unit tests cover the positive path plus unquoted scalars, duplicate ids, missing |
|
Addressed the automated cold-review findings in
The dated audit now records the cold-read findings and their dispositions. Focused Rust/Python tests, exact workflow lint, Markdown/link checks, and navigation verification pass locally after the update. |
ReviewNicely scoped, and consistent with this repo's fail-closed conventions (issue-numbered test, standard-library-only checker, negative regressions, CI wiring, navigation guide / README / CHANGELOG kept in sync per Code quality
Bugs
Test coverage
Security
Performance
Overall: solid, well-tested addition that matches the repository's documented conventions. The two notes above are minor/non-blocking. |
Review: Add contributor workflow and templates (#70)OverviewThis PR adds a Code quality and style
Specific suggestions
Potential issues / risks
Security
Test coverage
Overall this is a thorough, well-evidenced, low-risk documentation/tooling addition that matches the repository's existing conventions closely. The suggestions above are minor robustness/coverage improvements, not blockers. |
|
Final automated-review dispositions on
No blocking review item remains. All final-head CI, Linux/macOS/Windows, package identity, guide, and review checks are green. |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: ccfcc1b951
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| - [security and vulnerability-reporting limitations](docs/v0.2-contract.md#security-and-vulnerability-reporting); | ||
| - [supported CLI-only product and compatibility](docs/v0.2-contract.md#supported-product-and-rust-api); | ||
| - [release and Rust support policy](docs/release-policy.md); | ||
| - [contribution guide](CONTRIBUTING.md); |
There was a problem hiding this comment.
Keep the packaged contribution-guide link resolvable
The source package includes README.md but excludes CONTRIBUTING.md under the exact Cargo.toml allowlist (cargo package --locked --allow-dirty --list confirms only the README is present). Consequently, this relative link is broken when the packaged README is viewed from an extracted crate or another package-local context. Either include CONTRIBUTING.md in the reviewed package boundary or use an absolute repository URL.
Useful? React with 👍 / 👎.
Pull request
Problem
Issue #70 identified that contributors could not discover the supported setup, one-issue workflow, deterministic red-before-fix evidence, hermetic-test rules, complete validation matrix, or maintainer triage policy from the repository alone.
Before behavior
At base commit
b2e3ec848ba6e2553fdecfa5f7e6f98bcefb482e, the repository had no root contributor guide, issue forms, chooser configuration, pull request template, or fail-closed contract for those artifacts.After behavior
Adds a personal-repository contributor workflow, structured bug and contract-proposal forms, a private-security contact route, a pull request template, a constrained standard-library validator with negative tests, CI integration, navigation/docs updates, and a dated acceptance audit. It does not create an organization or team and does not add or run fuzzing.
Red-before-fix evidence
Base commit SHA:
b2e3ec848ba6e2553fdecfa5f7e6f98bcefb482e.Exact pre-fix command:
cargo test --locked --test issue_70_contributor_workflow -- --nocapture.It exited 101 with all three tests failing for the intended missing artifacts:
CONTRIBUTING.md,.github/ISSUE_TEMPLATE/01-bug.yml, and the issue #70 audit. Compilation and setup succeeded.Validation
Focused post-fix: three issue #70 Rust contracts, ten Python checker tests (including the checked-in repository), live checker, and a second Ruby YAML parse passed. The workflow-job proof explicitly establishes LF/CRLF equivalence after the first Windows run exposed the original LF-only extractor.
Full post-fix: exact Rust 1.85.0, 1.96.1, and 1.97.1 locked lanes passed; the conformance suite passed 393 tests with three documented ignores; the explicit packaged-artifact test passed separately; 101 policy tests and five deterministic parser-matrix tests passed. Exact package and publish dry-run commands passed from clean commit
34ce3479b8811b6afc85ccccdb41954be7fe4c1a. Formatting, actionlint, zizmor, rumdl, 95 link checks, and release-mode navigation verification passed.Local platform: macOS. Hosted CI supplies the authoritative Linux, macOS, and Windows matrix.
Documentation and compatibility
Documentation impact: adds
CONTRIBUTING.mdand the issue #70 audit; updates README, changelog, and navigation guide. Compatibility impact: no CLI, guide-language, package, or supported-platform behavior changes. The static site remains excluded.Security and sensitive data
Security impact: public forms route suspected vulnerabilities to the existing private advisory URL and warn against secrets, personal data, and private paths. The checker is standard-library-only and reads fixed repository files. The diff contains no token, private report detail, or path-sensitive fixture.
Dependencies and issue graph
Dependency or license impact: none; Cargo manifests, lockfile, graph, and attribution are unchanged. Closed prerequisites #55, #57, and #60 remain reflected in the guide. Open issue #63 still blocks publication on crates.io Trusted Publisher, and deferred issue #56 remains the only authority for any future generated fuzz/property work.
Checklist
Closes #70