docs: surface README community paths (Fixes #3827)#4339
Conversation
Fixes NVIDIA#3827 Signed-off-by: Deepak Jain <deepujain@gmail.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughThis PR restructures the NemoClaw README to surface community participation and support channels earlier and more prominently. A new "Get Involved" section presents a channel matrix directing users to appropriate resources (discussions, Discord, issues, contributing, milestones, security), while the "Community" section is updated to reference this matrix. A test validates the section presence, ordering, and required link content. ChangesCommunity Documentation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 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)
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 ESLint
ESLint skipped: no ESLint configuration detected in root package.json. To enable, add Comment |
|
✨ Thanks for submitting this detailed PR that adds a Get Involved block to the README, making it easier for new users and contributors to find the right channels for questions, bugs, and feature proposals. This proposes a fix for the issue where community paths were not easily accessible, and updates the README to include links to contribution guidance, GitHub Discussions, Discord, Issues, open milestones, SECURITY.md, and CODE_OF_CONDUCT.md. Related open issues: |
Summary
Adds an early README "Get Involved" block so new users and contributors can quickly find the right channel for questions, bugs, feature proposals, contributing, roadmap context, and security reports.
Fixes #3827.
Changes
README.md.good first issue, GitHub Discussions, Discord, Issues, open milestones,SECURITY.md, andCODE_OF_CONDUCT.md.Testing
npm run build:clinpm run typecheck:clinpm run docsnpx vitest run test/readme-community-links.test.tsEvidence it works
Summary by CodeRabbit
Documentation
Tests