Skip to content

docs: refine CONTRIBUTING.md for OrgExplorer stack and workflow#56

Open
kunal-bunkar wants to merge 1 commit intoAOSSIE-Org:mainfrom
kunal-bunkar:docs/improve-contributing-md
Open

docs: refine CONTRIBUTING.md for OrgExplorer stack and workflow#56
kunal-bunkar wants to merge 1 commit intoAOSSIE-Org:mainfrom
kunal-bunkar:docs/improve-contributing-md

Conversation

@kunal-bunkar
Copy link
Copy Markdown

@kunal-bunkar kunal-bunkar commented Apr 3, 2026

Addressed Issues:

Fixes #23

Additional Notes:

  • Replaced placeholder CONTRIBUTING content with OrgExplorer-specific setup (React 19, TypeScript, Vite, ESLint).
  • Documented npm run dev / lint / build / preview, repo layout, and git workflow with AOSSIE-Org/OrgExplorer upstream.
  • Removed broken Unicode in the old doc; aligned Discord + PR template expectations with the repo.

Checklist

  • My code follows the project's code style and conventions
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings or errors
  • I have joined the Discord server and I will share a link to this PR with the project maintainers there
  • I have read the Contributing Guidelines

Summary by CodeRabbit

  • Documentation
    • Updated contribution guidelines with clarified communication workflow between Discord and GitHub platforms.
    • Added table of contents and reorganized all contribution guide sections.
    • Enhanced PR checklist to emphasize linting and build verification steps.
    • Added AI notice requirement in pull request template.
    • Included specific technical guidance for TypeScript, React, and ESLint coding standards.

@github-actions github-actions bot added enhancement New feature or request documentation Improvements or additions to documentation size/L first-time-contributor labels Apr 3, 2026
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 3, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: b4b01ec7-0f5a-443f-9bed-90a9fa3d524a

📥 Commits

Reviewing files that changed from the base of the PR and between 1cfc3e7 and f07fd1d.

📒 Files selected for processing (1)
  • CONTRIBUTING.md

Walkthrough

The CONTRIBUTING.md file has been updated with OrgExplorer-specific content, including a table of contents, reorganized development workflow sections, refined communication guidelines prioritizing Discord for coordination and GitHub for code tracking, and enhanced PR submission requirements emphasizing automated checks and conventional commits.

Changes

Cohort / File(s) Summary
Documentation Update
CONTRIBUTING.md
Replaced placeholder content with OrgExplorer-specific guidance; added table of contents and reorganized sections (contribution types, project overview, getting started, environment variables, development workflow); clarified Discord/GitHub communication roles; enhanced PR checklist with emphasis on npm run lint/npm run build and conventional commit conventions; added TypeScript/React/ESLint code style guidance.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Suggested labels

Documentation

Suggested reviewers

  • Zahnentferner

Poem

🐰 Hops through the docs with glee,
A guide refined for all to see,
Discord chats and GitHub flows,
Contributing garden beautifully grows! 🌱✨

🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: refine CONTRIBUTING.md for OrgExplorer stack and workflow' clearly and specifically summarizes the main change: updating the CONTRIBUTING.md documentation for the OrgExplorer project.
Linked Issues check ✅ Passed The pull request fully addresses issue #23 by replacing placeholder CONTRIBUTING.md content with OrgExplorer-specific guidance covering the project stack (React 19, TypeScript, Vite, ESLint), workflow commands, repository layout, and contributor expectations.
Out of Scope Changes check ✅ Passed All changes are directly scoped to improving CONTRIBUTING.md as specified in issue #23; no unrelated modifications or out-of-scope additions are present.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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/L and removed size/L labels Apr 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request first-time-contributor size/L

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[FEATURE]: Improve and Refine CONTRIBUTING.md for OrgExplorer

1 participant