Skip to content

docs: add roadmap and GitHub contribution templates#7

Merged
imuniqueshiv merged 1 commit into
mainfrom
docs/open-source-documentation
Jun 27, 2026
Merged

docs: add roadmap and GitHub contribution templates#7
imuniqueshiv merged 1 commit into
mainfrom
docs/open-source-documentation

Conversation

@imuniqueshiv

@imuniqueshiv imuniqueshiv commented Jun 27, 2026

Copy link
Copy Markdown
Owner

Summary

This PR improves the project's open-source contribution experience by adding community documentation and standardized GitHub templates.

Changes

  • Add ROADMAP.md
  • Add Pull Request template
  • Add Bug Report issue form
  • Add Feature Request issue form
  • Add Documentation issue form
  • Add Question issue form

Validation

  • Prettier
  • ESLint
  • TypeScript
  • Production build

Notes

These changes improve contributor onboarding and standardize issue and pull request workflows.

Summary by CodeRabbit

  • Documentation
    • Added new templates for bug reports, documentation requests, feature requests, and questions to make issue submissions more structured and consistent.
    • Added a pull request template with clearer sections for summary, changes, testing, screenshots, and review checklist.
    • Added a roadmap document outlining product vision, milestones, and contribution guidance.

@vercel

vercel Bot commented Jun 27, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
hyper-learning-tech Ready Ready Preview, Comment Jun 27, 2026 2:17am

@coderabbitai

coderabbitai Bot commented Jun 27, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

Pull request was closed or merged during review

📝 Walkthrough

Walkthrough

Adds GitHub issue forms for bug, documentation, feature request, and question submissions, plus a pull request template. Also adds ROADMAP.md with project vision, phased milestones, technical goals, community goals, and contribution guidance.

Changes

Issue and pull request templates

Layer / File(s) Summary
Issue form templates
.github/ISSUE_TEMPLATE/*.yml
Adds bug, documentation, feature request, and question issue forms with metadata, structured fields, and checklists.
Pull request template
.github/PULL_REQUEST_TEMPLATE.md
Adds a pull request template with summary, related issue, change, testing, checklist, and notes sections.

Roadmap document

Layer / File(s) Summary
Roadmap content
ROADMAP.md
Adds the roadmap document with project status, vision, guiding principles, phased milestones, technical roadmap, community goals, and contribution guidance.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

A bunny hopped through forms and lore,
With checklist leaves and roadmap store.
Bugs, questions, dreams now have a pen,
And future paths are mapped again. 🐰

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 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 PR’s main addition: a roadmap plus GitHub contribution templates and issue forms.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/open-source-documentation

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.

@imuniqueshiv imuniqueshiv merged commit 53f41ad into main Jun 27, 2026
3 checks passed
@imuniqueshiv imuniqueshiv deleted the docs/open-source-documentation branch June 27, 2026 02:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant