docs: add CONTRIBUTING.md#56
Conversation
Standard OSS-onboarding doc: dev setup, prek hooks, branch+PR flow, conventional-commit conventions for release-please, fork-PR CI fallback, test commands, bug-vs-security split, code style. No CODE_OF_CONDUCT yet — separate decision.
📝 WalkthroughWalkthroughThis PR introduces ChangesContribution Guidelines
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
CONTRIBUTING.md (1)
76-79: 💤 Low valueConsider clarifying "Per-PR CI" phrasing.
The phrase "Per-PR CI only builds the native crate on linux-x64" could be slightly clearer. Consider: "CI on pull requests only builds the native crate on linux-x64" to make it more explicit that this refers to the PR workflow specifically.
✏️ Suggested rewording
-`main` is the integration branch and is **not guaranteed stable between releases**. Per-PR CI only builds the native crate on linux-x64 to keep PR turnaround fast; the full 5-platform matrix (linux x64/arm64, macOS x86/arm64, Windows) runs on `push: main` and on release tags. +`main` is the integration branch and is **not guaranteed stable between releases**. CI on pull requests only builds the native crate on linux-x64 to keep PR turnaround fast; the full 5-platform matrix (linux x64/arm64, macOS x86/arm64, Windows) runs on `push: main` and on release tags.🤖 Prompt for 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. In `@CONTRIBUTING.md` around lines 76 - 79, The sentence under the "What `main` looks like" section is unclear: replace "Per-PR CI only builds the native crate on linux-x64" with a clearer phrase such as "CI on pull requests only builds the native crate on linux-x64" to explicitly reference the PR workflow; update the paragraph containing that sentence to use the new wording so readers understand it refers specifically to the pull-request CI run.
🤖 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 50-54: The fenced code block in CONTRIBUTING.md that shows the
breaking change for createCache.minimal → createCache.fast lacks a language
specifier; update the triple-backtick fence for that block to include a language
(e.g., "text") so it renders and lints properly (the block containing "feat:
rename createCache.minimal to createCache.fast" and "BREAKING CHANGE:
createCache.minimal is now createCache.fast.").
---
Nitpick comments:
In `@CONTRIBUTING.md`:
- Around line 76-79: The sentence under the "What `main` looks like" section is
unclear: replace "Per-PR CI only builds the native crate on linux-x64" with a
clearer phrase such as "CI on pull requests only builds the native crate on
linux-x64" to explicitly reference the PR workflow; update the paragraph
containing that sentence to use the new wording so readers understand it refers
specifically to the pull-request CI run.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
| ``` | ||
| feat: rename createCache.minimal to createCache.fast | ||
|
|
||
| BREAKING CHANGE: createCache.minimal is now createCache.fast. | ||
| ``` |
There was a problem hiding this comment.
Add language specifier to fenced code block.
The code block showing the breaking change format should include a language specifier for proper rendering and linting compliance.
📝 Proposed fix
-```
+```text
feat: rename createCache.minimal to createCache.fast
BREAKING CHANGE: createCache.minimal is now createCache.fast.</details>
<details>
<summary>🧰 Tools</summary>
<details>
<summary>🪛 markdownlint-cli2 (0.22.1)</summary>
[warning] 50-50: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
</details>
</details>
<details>
<summary>🤖 Prompt for AI Agents</summary>
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In @CONTRIBUTING.md around lines 50 - 54, The fenced code block in
CONTRIBUTING.md that shows the breaking change for createCache.minimal →
createCache.fast lacks a language specifier; update the triple-backtick fence
for that block to include a language (e.g., "text") so it renders and lints
properly (the block containing "feat: rename createCache.minimal to
createCache.fast" and "BREAKING CHANGE: createCache.minimal is now
createCache.fast.").
</details>
<!-- fingerprinting:phantom:triton:puma -->
<!-- This is an auto-generated comment by CodeRabbit -->
1 participant
Summary
Adds the standard OSS-onboarding doc that's been on the public-readiness shortlist. Targets the friction points an external contributor actually hits — dev setup, hook installation, branch/PR flow, conventional-commit conventions (release-please reads them), fork-PR CI behavior, and bug-vs-security reporting split.
Sections
prek install --install-hooks, Pythonpre-commitfallback notedIntentionally not in scope
Test plan
Summary by CodeRabbit