add(docs): contributor naming conventions doc#1931
Conversation
|
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (5)
📝 WalkthroughWalkthroughDocumentation for naming conventions is introduced as a comprehensive contributor guide covering folder/file structures, component patterns, contexts/providers/hooks, and test/story naming. The guide is integrated into the contributing docs navigation and linked from the "Before submitting" prerequisite section. ChangesNaming Conventions Documentation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested labels
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 docstrings
🧪 Generate unit tests (beta)
Comment |
Summary
/docs/contributingBefore You StartWhy
context/vscontexts/transition without doing unrelated renamesValidation
pnpm exec eslint app/docs/docsNavigationSections.tsx app/docs/contributing/naming-conventions/page.tsx app/docs/contributing/naming-conventions/seo.tspnpm buildindocs/Build blocker
pnpm buildcurrently fails on unrelated existing docs errors inapp/docs/components/toast/docs/example_action.tsxand related toast example files because@radui/ui/Toastis not exported from the package used by the docs appRisks / follow-ups
context/andcontexts/; this PR documents the preferred convention for new work but does not rename existing foldersCloses #1831
Summary by CodeRabbit