docs: match CONTRIBUTING.md's test command to what CI runs - #8427
Merged
youknowone merged 1 commit intoAug 1, 2026
Conversation
`cargo test --workspace ...` segfaults on rustpython-capi when run from the workspace root; it needs its own config that only applies inside crates/capi. CI already excludes it from the workspace run and tests it separately. Document both. Closes RustPython#8415 Assisted-by: Claude Code:claude-sonnet-5
Contributor
📝 WalkthroughWalkthroughThe contributor guide updates Rust test commands. Workspace tests exclude ChangesContributor testing instructions
Estimated code review effort: 1 (Trivial) | ~5 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
leehanjeong
marked this pull request as ready for review
August 1, 2026 09:07
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@CONTRIBUTING.md`:
- Around line 92-100: Remove the `$` shell prompt prefixes from the command-only
examples in the CONTRIBUTING documentation, including the workspace test command
and the commands in the crates/capi example, while preserving the commands and
code-block structure.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yml
Review profile: CHILL
Plan: Pro Plus
Run ID: 59e9fad4-08bf-42f2-bf00-b3fc0e2a091a
📒 Files selected for processing (1)
CONTRIBUTING.md
youknowone
enabled auto-merge (squash)
August 1, 2026 11:17
youknowone
disabled auto-merge
August 1, 2026 11:17
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
2 participants
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.
Summary
CONTRIBUTING.md's documentedcargo test --workspace ...command doesn't match what CI runs, and segfaults onrustpython-capiwhen run from the workspace root. Add--exclude rustpython-capiand document the separatecd crates/capi && cargo teststep, mirroring CI.Kept this docs-only rather than restructuring
crates/capiout of the workspace: that would mean hardcoding ~16workspace = truefields, a separateCargo.lock, and new CI steps for build/clippy/doc/shear that currently reach it through the root workspace.Assisted-by: Claude Code:claude-sonnet-5
Summary by CodeRabbit