Skip to content

Conversation

@shahabhilash
Copy link
Contributor

@shahabhilash shahabhilash commented Oct 19, 2025

Small docs improvement: added a short tip recommending contributors check the "good first issue" label for fast frontend/docs tasks that can be done via the GitHub web editor.

  • Change: added a one-line tip to CONTRIBUTING.md
  • Why: helps new contributors find easy issues and make quick PRs (no local setup required)
  • Type: documentation only — no code changes

Summary by CodeRabbit

  • Documentation
    • Updated contributing guidelines with improved information about getting started with contributions and the contribution process.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 19, 2025

📝 Walkthrough

Walkthrough

The CONTRIBUTING.md documentation file has been updated with a new tip about quick contributions using the "good first issue" label and a minor wording adjustment to the closing section.

Changes

Cohort / File(s) Summary
Documentation Updates
CONTRIBUTING.md
Added front-matter tip highlighting quick contributions via "good first issue" label; minor wording/formatting adjustment to the "For further advice on contributing" closing line

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f47e861 and 5347341.

📒 Files selected for processing (1)
  • CONTRIBUTING.md (2 hunks)
🔇 Additional comments (2)
CONTRIBUTING.md (2)

2-3: New tip effectively guides new contributors to quick-win issues.

The added blockquote provides clear, actionable guidance for contributors seeking low-friction entry points. The tip is well-positioned at the top of the guide and correctly references the existing "good first issue" label, making it easy for new contributors to find approachable tasks.


229-229: Reconsider the addition of "NEW" before "contributing guide."

The word "NEW" feels unmotivated here. If the guide is an existing resource, labeling it as "NEW" will become outdated and potentially misleading. Consider removing it unless there's a specific, time-bound reason for highlighting it as new (e.g., a recent major overhaul).

[suggest_minor_issue]


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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@vanessayuenn vanessayuenn added documentation ci:docs Run the CI jobs for documentation checks only. labels Oct 20, 2025
Copy link
Contributor

@jonniebigodes jonniebigodes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@shahabhilash, thank you for putting together this pull request and helping us improve the documentation on onboarding users to contribute to Storybook. We appreciate it 🙏 !

I've checked and all is good on my end.

Going to merge this as soon as the checklist clears.

Hope you have a great week

Stay safe

@jonniebigodes jonniebigodes changed the title docs: add tip to check "good first issue" for quick frontend/docs contributions Docs: Update monorepo contribution guide Oct 20, 2025
@nx-cloud
Copy link

nx-cloud bot commented Oct 20, 2025

View your CI Pipeline Execution ↗ for commit 11fecb3

Command Status Duration Result
nx run-many -t build --parallel=3 ✅ Succeeded 1m 16s View ↗

☁️ Nx Cloud last updated this comment at 2025-10-20 16:58:29 UTC

@jonniebigodes jonniebigodes merged commit dced9cb into storybookjs:next Oct 20, 2025
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci:docs Run the CI jobs for documentation checks only. documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants