docs: CONTRIBUTING says clippy is not gated at PR time, but ci.yml runs -D warnings clippy on PRs
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 88/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- github-actions, rust
- Domain
- ci-cd, documentation
Research direction
Read CONTRIBUTING.md around lines 46 and 50, then inspect the pull_request-triggered jobs in .github/workflows/ci.yml, especially the clippy job and its comment. Update the bullet and inline comment so they accurately describe the PR-time jobs and gates. Done means the CONTRIBUTING.md description matches the workflow's actual PR behavior.
Written by the indexing model from the issue text.
Description
Summary
CONTRIBUTING.md tells contributors that clippy is "NOT gated at PR time" and that PR CI runs "only the cheap gates", but ci.yml runs a -D warnings clippy job on every Rust-touching PR, plus several further PR-time gates the paragraph never mentions. A contributor who trusts CONTRIBUTING is surprised by CI.
Background
The paragraph describes a CI arrangement that predates the clippy job being re-added to ci.yml. The job's own comment even notes it re-adds what earlier issues removed, so the docs and the workflow now disagree.
Proposed Solution
Rewrite the bullet and the inline comment against the actual PR job list, which is trivially enumerable from ci.yml.
Implementation Notes
CONTRIBUTING.md:46: "cargo clippy --workspace --all-targets ... -D warnings # NOT gated at PR time; yours to run".CONTRIBUTING.md:50: "PR-time CI runs only the cheap gates ... Clippy and the general unit suite are not enforced on your PR.".github/workflows/ci.yml:53-57(confirmed): triggers onpull_request: branches: [main]..github/workflows/ci.ymlclippy job runscargo clippy -p mlxcel --lib --tests -- -D warnings(confirmed-- -D warningsat:214) when Rust files changed.- Additional PR-time gates unmentioned by the paragraph:
crate-versions,kernel-dtype-keys,llama-compat-manifest,mlx-pin,cross-repo-refs(advisory),xla-compile,xla-link,cuda-sm70-compile.
Acceptance Criteria
- CONTRIBUTING's description of PR-time CI matches the jobs
ci.ymlactually runs on PRs.
Original Suggestion
Title: docs: CONTRIBUTING says clippy is not gated at PR time, but ci.yml runs -D warnings clippy on PRs
CONTRIBUTING.md tells contributors that clippy is "NOT gated at PR time" and that PR CI runs "only the cheap gates" — but ci.yml runs a -D warnings clippy job on every Rust-touching PR, plus seven further PR-time gates the paragraph never mentions. A contributor who trusts CONTRIBUTING gets surprised by CI.
Evidence
CONTRIBUTING.md:46— "cargo clippy --workspace --all-targets …# NOT gated at PR time; yours to run"CONTRIBUTING.md:50— "PR-time CI runs only the cheap gates:cargo fmt,cargo denyand a workspace crate-version consistency check … Clippy and the general unit suite are not enforced on your PR.".github/workflows/ci.yml:53-57— runs onpull_request: branches: [main].github/workflows/ci.yml:155-215— theclippyjob runscargo clippy -p mlxcel --lib --tests -- -D warningswhen Rust files changed; its own comment at:207-209notes it re-adds what earlier issues removed
Additional PR-time ci.yml gates unmentioned by the paragraph: crate-versions (:216), kernel-dtype-keys (:239), llama-compat-manifest (:260), mlx-pin (:299), cross-repo-refs (:345, advisory), xla-compile (:417), xla-link (:576), cuda-sm70-compile (:657).
Suggested fix
Rewrite the bullet and the inline comment against the actual job list, which is trivially enumerable from ci.yml.
Acceptance criteria
- CONTRIBUTING's description of PR-time CI matches the jobs
ci.ymlactually runs on PRs
- Dominant language
- Rust
- Stars
- 470
- Forks
- 54
- Avg merge
- 4h 45m
- Merged PRs (30d)
- 305
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from lablup/mlxcel
-
area:core priority:low status:ready type:chore
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
-
priority:low status:ready type:docs
Difficulty 1/5 Under an hour Newbie friendliness 95/100
-
docs(webpage): add a webpage/site README covering the pnpm/uv/zensical build and deploy contract Openpriority:low status:ready type:docs
Difficulty 1/5 1-3 hours Newbie friendliness 86/100
-
priority:low status:ready type:docs
Difficulty 2/5 1-3 hours Newbie friendliness 92/100
-
priority:medium status:ready type:docs
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Eynzof/Hermes-CN-Desktop#610 ·
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
gitbutlerapp/gitbutler#15998 · 1 comment ·
-
bug triage:deciding
Difficulty 1/5 Under an hour Newbie friendliness 88/100
open-telemetry/otel-arrow#4132 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100