docs: integrate CI into the contributor story#171
Merged
Conversation
Follow-up to #169 (the CI workflow itself): wire the new CI into the docs that tell people how to work here. README gains the ci badge and a crates.io badge for kaish-kernel, and the "Status:" line stops hand-maintaining a version number that had already drifted (said 0.11, we're on 0.12) — the badge carries it now. Building from Source shows the clippy gate and names ci.yml as the enforcement point; Contributing notes CI must be green and that runners track current stable Rust, so CI clippy can know lints a local toolchain doesn't (discovered live when 1.97's question_mark lint failed a run that 1.96 passed). CLAUDE.md's Build Commands section now documents what CI runs and the keep-ci.yml-in-sync rule; the pre-commit gate list notes CI enforces it. Devlog entry covers the whole arc: first run failed two of three jobs, every failure a pre-existing repo bug (builtin-shadowed readlink stdin test, a no-default-features test leg that never compiled → GH #170, toolchain-drift clippy). Co-Authored-By: Claude Fable 5 <[email protected]>
…ch CI doesn't run — name the gates instead (kaibo review nit) Co-Authored-By: Claude Fable 5 <[email protected]>
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.
Follow-up to #169: the workflow exists; this wires it into the docs contributors actually read, and serves as the final validation pass — this PR itself exercises the
pull_requesttrigger on a fresh branch, and its merge will light the README badge from thepush-to-main leg.Status:line stops hand-maintaining a version number — it had already drifted (said 0.11, we're on 0.12); the badge carries it now. "Building from Source" shows the clippy gate and points atci.yml; "Contributing" notes CI must be green and warns that runners track current stable Rust, so CI clippy may know lints your local toolchain doesn't (this bit us live: 1.97'squestion_markfailed a run 1.96 passed).ci.yml-in-sync rule, and the fix-the-code-don't-pin-the-toolchain stance; the pre-commit gate list notes CI now enforces it.readlinkstdin test; a no-default-features test leg that never compiled → cargo test -p kaish-kernel --no-default-features has never compiled — feature-gate the integration-test crates #170; toolchain-drift clippy).🤖 Generated with Claude Code