Skip to content

docs: improve CONTRIBUTING.md with OrgExplorer-specific setup and gui…#24

Open
Aditya30ag wants to merge 1 commit intoAOSSIE-Org:mainfrom
Aditya30ag:docs/improve-contributing-guide
Open

docs: improve CONTRIBUTING.md with OrgExplorer-specific setup and gui…#24
Aditya30ag wants to merge 1 commit intoAOSSIE-Org:mainfrom
Aditya30ag:docs/improve-contributing-guide

Conversation

@Aditya30ag
Copy link

@Aditya30ag Aditya30ag commented Feb 22, 2026

Summary

Improves and refines the CONTRIBUTING.md file to better align with the current OrgExplorer project setup.
I know it is not finalize yet but still the repo name show be mention there .

Changes

  • Replaced placeholder project name with OrgExplorer
  • Updated repository and organization URLs
  • Added project-specific prerequisites (Node.js 18+, Git, etc.)
  • Added working development commands (npm run dev, npm run lint, npm run build)
  • Added ESLint & TypeScript configuration references
  • Removed irrelevant Python section

Impact

  • Improves onboarding clarity
  • Aligns documentation with actual tech stack
  • Makes contribution process clearer for new contributors

Note: This is an improvement step and the document may be refined further in future updates.

Summary by CodeRabbit

  • Documentation
    • Refreshed contributor guide with updated prerequisites, repository URLs, and development commands.
    • Clarified code style guidelines for React and TypeScript development.
    • Reorganized sections to reflect project workflow and community expectations.

@coderabbitai
Copy link

coderabbitai bot commented Feb 22, 2026

No actionable comments were generated in the recent review. 🎉


📝 Walkthrough

Walkthrough

The CONTRIBUTING.md file is rebranded from TODO placeholders to OrgExplorer-specific guidance, replacing repository URLs, tech stack prerequisites, setup commands, testing procedures, and code style guidelines with concrete OrgExplorer implementations.

Changes

Cohort / File(s) Summary
Documentation Update
CONTRIBUTING.md
Rebranded contributor guide from TODO project to OrgExplorer. Updated prerequisites, repository URLs, setup/development commands, testing and linting procedures, code style guidelines for React/TypeScript, and section terminology. Organized workflow expectations around Discord-centric practices.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested labels

size/XS

Suggested reviewers

  • Zahnentferner

Poem

🐰 A guide so grand, no longer TODO's way,
OrgExplorer shines bright as day!
With Discord dreams and React's sweet grace,
Contributors dance in this new space.
Hop along, dear devs, the path is clear!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: updating CONTRIBUTING.md with OrgExplorer-specific setup and GUI information, replacing TODO placeholders with concrete project details.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

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

Tip

Issue Planner is now in beta. Read the docs and try it out! Share your feedback on Discord.


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.

@github-actions github-actions bot added size/S and removed size/S labels Feb 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant