docs: add CONTRIBUTING-BEGINNERS.md for new contributors#1682
Conversation
📝 WalkthroughWalkthroughThis PR adds a comprehensive beginner-focused contribution guide as ChangesBeginner Contributor Onboarding
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Tip 💬 Introducing Slack Agent: The best way for teams to turn conversations into code.Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.
Built for teams:
One agent for your entire SDLC. Right inside Slack. 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 |
![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
🤖 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-BEGINNERS.md`:
- Line 19: Update the heading text instances that use “up to date” to the
hyphenated form “up-to-date” for consistency; specifically change the link/text
"[Keeping your fork up to date](`#keeping-your-fork-up-to-date`)" and the other
occurrence at the noted location to use "up-to-date" so both the visible heading
and its anchor text are hyphenated consistently.
🪄 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: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 4e699704-0ebc-4b08-b6c7-b365a544f284
📒 Files selected for processing (2)
CONTRIBUTING-BEGINNERS.mdCONTRIBUTING.md
| - [Step 5 — Create your branch](#step-5--create-your-branch) | ||
| - [Step 6 — Make your change and verify it](#step-6--make-your-change-and-verify-it) | ||
| - [Step 7 — Push and open a Pull Request](#step-7--push-and-open-a-pull-request) | ||
| - [Keeping your fork up to date](#keeping-your-fork-up-to-date) |
There was a problem hiding this comment.
Hyphenate “up-to-date” in headings for consistency.
Use “up-to-date” instead of “up to date” (Line 19 and Line 235) to keep heading grammar polished.
Also applies to: 235-235
🧰 Tools
🪛 LanguageTool
[grammar] ~19-~19: Use a hyphen to join words.
Context: ...-a-pull-request) - Keeping your fork up to date - [...
(QB_NEW_EN_HYPHEN)
🤖 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-BEGINNERS.md` at line 19, Update the heading text instances that
use “up to date” to the hyphenated form “up-to-date” for consistency;
specifically change the link/text "[Keeping your fork up to
date](`#keeping-your-fork-up-to-date`)" and the other occurrence at the noted
location to use "up-to-date" so both the visible heading and its anchor text are
hyphenated consistently.
kedar49
left a comment
kedar49
left a comment
There was a problem hiding this comment.
Why do we need two contributor files?
It’s a bit confusing, but still helpful for beginners though
3 participants
Summary
CONTRIBUTING-BEGINNERS.mdfile with a full step-by-step onboarding guide for contributors new to open source or codingCONTRIBUTING.mdso new contributors can find the guide immediatelyProblem
New contributors hit multiple undocumented setup blockers when trying to contribute for the first time. There are no beginner-friendly labels and no single guide that walks someone through the full flow end-to-end. Issue #1658 identifies this as a barrier to community contributions.
Solution
A dedicated
CONTRIBUTING-BEGINNERS.mdthat covers every step from zero to first PR, written from the perspective of someone who just went through the real setup process on macOS. The guide points to the existingCONTRIBUTING.mdand GitBook docs for deeper reference rather than duplicating them.Submission Checklist
N/A: docs-only change, no code modifiedN/A: docs-only change, no executable linesN/A: no feature rows added or removedN/A: docs-only changeN/A: no release-cut surfaces touchedCloses #NNN— see Related belowImpact
Docs-only. No runtime, platform, or behavioural impact.
Related
AI Authored PR Metadata (required for Codex/Linear PRs)
HemanthValidation Run
pnpm format:check— Prettier passed, all files unchangedpnpm typecheck— N/A: docs-only changeValidation Blocked
cargo fmt --manifest-path Cargo.toml --all --checksh: cargo: command not foundBehavior Changes
Parity Contract
Duplicate / Superseded PR Handling
Summary by CodeRabbit