diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..8664184 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,123 @@ +name: Bug Report +description: Report a reproducible bug or unexpected behavior in Hyper Learning Tech. +title: "[Bug]: " +labels: + - bug + +body: + - type: markdown + attributes: + value: | + ## Thanks for reporting a bug! + + Before submitting this report, please: + + - Search existing issues. + - Verify the issue on the latest version. + - Provide enough information for us to reproduce it. + + - type: textarea + id: description + attributes: + label: Bug Description + description: Describe the issue clearly. + placeholder: Tell us what happened... + validations: + required: true + + - type: textarea + id: reproduction + attributes: + label: Steps to Reproduce + description: Explain exactly how to reproduce the issue. + placeholder: | + 1. Go to... + 2. Click... + 3. Enter... + 4. Observe... + validations: + required: true + + - type: textarea + id: expected + attributes: + label: Expected Behavior + description: What did you expect to happen? + validations: + required: true + + - type: textarea + id: actual + attributes: + label: Actual Behavior + description: What actually happened? + validations: + required: true + + - type: dropdown + id: area + attributes: + label: Affected Area + description: Select the part of the project where the issue occurs. + options: + - AI Workspace + - AI Answer Generation + - Dashboard + - Previous Year Questions (PYQs) + - Syllabus + - Search + - API + - Performance + - Documentation + - Build / CI + - Other + validations: + required: true + + - type: input + id: browser + attributes: + label: Browser (Optional) + placeholder: Chrome 138, Firefox 140, Edge... + + - type: input + id: os + attributes: + label: Operating System (Optional) + placeholder: Windows 11, Ubuntu 24.04, macOS... + + - type: input + id: node + attributes: + label: Node.js Version (Optional) + placeholder: v22.16.0 + + - type: textarea + id: logs + attributes: + label: Logs / Error Messages + description: Paste any relevant logs or stack traces. + render: shell + + - type: textarea + id: screenshots + attributes: + label: Screenshots (Optional) + description: Drag and drop screenshots or recordings here if applicable. + + - type: checkboxes + id: checklist + attributes: + label: Checklist + options: + - label: I searched existing issues before creating this report. + required: true + + - label: I can consistently reproduce this issue. + required: true + + - label: I tested on the latest version of the project. + required: true + + - label: I have included all relevant information needed to reproduce this issue. + required: true diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml new file mode 100644 index 0000000..ee8b1b1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.yml @@ -0,0 +1,77 @@ +name: Documentation +description: Report documentation issues or suggest improvements. +title: "[Docs]: " +labels: + - documentation + +body: + - type: markdown + attributes: + value: | + ## Documentation Improvement + + Thank you for helping improve Hyper Learning Tech's documentation. + + Before submitting: + + - Search existing Issues. + - Check if the documentation already covers your topic. + - Keep one documentation request per issue. + + - type: dropdown + id: category + attributes: + label: Documentation Area + description: Which documentation needs improvement? + options: + - README + - CONTRIBUTING Guide + - Installation + - Setup / Environment Variables + - Architecture + - API Documentation + - AI Workspace + - Deployment + - GitHub Workflows + - Code Comments + - Other + validations: + required: true + + - type: textarea + id: issue + attributes: + label: What is missing or incorrect? + description: Describe the documentation issue. + placeholder: Explain what is outdated, missing, unclear, or incorrect. + validations: + required: true + + - type: textarea + id: suggestion + attributes: + label: Suggested Improvement + description: How should the documentation be improved? + placeholder: Describe your proposed changes. + validations: + required: true + + - type: textarea + id: references + attributes: + label: References (Optional) + description: Add links, screenshots, examples, or related resources that may help improve the documentation. + + - type: checkboxes + id: checklist + attributes: + label: Checklist + options: + - label: I searched existing documentation before creating this issue. + required: true + + - label: This issue is focused on documentation only. + required: true + + - label: I have clearly described the improvement. + required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..c1b0735 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,110 @@ +name: Feature Request +description: Suggest a new feature or enhancement for Hyper Learning Tech. +title: "[Feature]: " +labels: + - enhancement + +body: + - type: markdown + attributes: + value: | + ## Thank you for your suggestion! + + Before submitting a feature request: + + - Search existing Issues and Discussions. + - Check the project roadmap. + - Clearly explain the problem you are trying to solve. + + - type: textarea + id: problem + attributes: + label: Problem Statement + description: What problem or limitation are you experiencing? + placeholder: Describe the problem... + validations: + required: true + + - type: textarea + id: solution + attributes: + label: Proposed Solution + description: Describe the solution you would like to see. + placeholder: Explain your proposed solution... + validations: + required: true + + - type: textarea + id: alternatives + attributes: + label: Alternatives Considered + description: Describe any alternative solutions or features you have considered. + placeholder: List any alternatives you have explored... + + - type: dropdown + id: area + attributes: + label: Feature Area + description: Which part of the project would this feature affect? + options: + - AI Workspace + - AI Answer Generation + - Dashboard + - Previous Year Questions (PYQs) + - Syllabus + - Search + - Authentication + - API + - Performance + - Documentation + - Developer Experience + - Build / CI + - Other + validations: + required: true + + - type: dropdown + id: priority + attributes: + label: Suggested Priority + options: + - Low + - Medium + - High + validations: + required: true + + - type: textarea + id: benefits + attributes: + label: Expected Benefits + description: How would this feature improve Hyper Learning Tech? + placeholder: Explain the expected impact... + validations: + required: true + + - type: textarea + id: mockups + attributes: + label: Mockups or References (Optional) + description: Add screenshots, wireframes, links, or references if applicable. + + - type: textarea + id: additional + attributes: + label: Additional Context (Optional) + description: Include any other information that may help maintainers understand your request. + + - type: checkboxes + id: checklist + attributes: + label: Checklist + options: + - label: I searched existing Issues and Discussions before creating this request. + required: true + + - label: This request is focused on a single feature or improvement. + required: true + + - label: I have provided enough information for maintainers to evaluate this request. + required: true diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml new file mode 100644 index 0000000..2364db4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -0,0 +1,78 @@ +name: Question +description: Ask a question about Hyper Learning Tech. +title: "[Question]: " +labels: + - question + +body: + - type: markdown + attributes: + value: | + ## Ask a Question + + Thanks for your interest in Hyper Learning Tech! + + Before creating a question: + + - Search existing Issues and Discussions. + - Read the README and CONTRIBUTING guide. + - Keep your question clear and specific. + + - type: dropdown + id: category + attributes: + label: Question Category + description: What is your question about? + options: + - Getting Started + - Installation + - Development Setup + - Project Architecture + - AI Workspace + - AI Answer Generation + - Previous Year Questions (PYQs) + - Syllabus + - API + - Deployment + - GitHub Workflow + - Contributing + - Documentation + - Other + validations: + required: true + + - type: textarea + id: question + attributes: + label: Your Question + description: Clearly describe your question. + placeholder: Ask your question here... + validations: + required: true + + - type: textarea + id: attempted + attributes: + label: What Have You Tried? + description: Describe any steps you've already taken to solve the problem. + placeholder: Mention any documentation, code, or resources you've already checked. + + - type: textarea + id: context + attributes: + label: Additional Context + description: Provide screenshots, links, code snippets, or any additional information that may help us understand your question. + + - type: checkboxes + id: checklist + attributes: + label: Checklist + options: + - label: I searched existing Issues and Discussions before asking this question. + required: true + + - label: I have read the project documentation. + required: true + + - label: I have provided enough information for maintainers to understand my question. + required: true diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..6d5df60 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,67 @@ +# Pull Request + +## Summary + +Provide a brief description of your changes. + +--- + +## Related Issue + +Closes # + +--- + +## Type of Change + +- [ ] Feature +- [ ] Bug Fix +- [ ] Documentation +- [ ] Refactor +- [ ] Performance Improvement +- [ ] CI / Build +- [ ] Other + +--- + +## What Changed? + +Briefly describe the key changes made in this Pull Request. + +- +- +- *** + +## Screenshots (UI Changes Only) + +If this PR includes UI changes, attach screenshots or recordings. + +--- + +## Testing + +Describe how you tested your changes. + +- +- *** + +## Checklist + +Before requesting a review, confirm the following: + +- [ ] My branch is up to date with the latest `main`. +- [ ] My code follows the project's coding standards. +- [ ] I have formatted the modified files (`npx prettier --write `). +- [ ] `npm run format:check` passes. +- [ ] `npm run lint` passes. +- [ ] `npm run typecheck` passes. +- [ ] `npm run build` passes. +- [ ] I have updated documentation if required. +- [ ] I have tested my changes locally. +- [ ] This Pull Request focuses on a single feature or fix. + +--- + +## Additional Notes + +Add any additional context for reviewers if needed. diff --git a/ROADMAP.md b/ROADMAP.md new file mode 100644 index 0000000..a3138f7 --- /dev/null +++ b/ROADMAP.md @@ -0,0 +1,272 @@ +# Roadmap + +This document outlines the long-term vision and planned development milestones for **Hyper Learning Tech**. + +The roadmap is intended to help contributors understand the project's direction and identify areas where contributions are most valuable. + +> **Note** +> +> Roadmap priorities may evolve as the project grows, community feedback is received, and new educational needs emerge. + +--- + +# Current Status + +**Project Phase** + +Active Development 🚧 + +**Current Release** + +v0.1.x + +**Production Website** + +https://www.hyperlearningtech.in + +--- + +# Vision + +Hyper Learning Tech aims to become an intelligent academic learning platform that combines structured educational content with AI-powered learning experiences. + +Our long-term objective is to help students move beyond static notes and previous year papers by providing contextual explanations, personalized guidance, and interactive learning tools. + +--- + +# Guiding Principles + +Every feature should improve at least one of the following: + +- Student learning experience +- Developer experience +- Platform performance +- Accessibility +- Scalability +- Reliability +- Maintainability + +--- + +# Development Roadmap + +## Phase 1 — Foundation + +**Status:** ✅ In Progress + +### Objectives + +- Build a modern Next.js application. +- Establish scalable project architecture. +- Create a production-ready development workflow. +- Build the academic content management system. + +### Completed + +- Next.js 16 application +- TypeScript setup +- GitHub Actions CI +- CodeRabbit integration +- Branch protection rules +- Apache 2.0 License +- Project documentation +- Google Search Console integration +- robots.txt +- sitemap.xml +- Custom domain +- Vercel deployment + +--- + +## Phase 2 — AI Learning Platform + +**Status:** 🚧 Active Development + +### Goals + +- Hyper AI Workspace +- AI Answer Generation +- Topic Explanations +- Smart Prompt Builder +- AI Notes +- AI Study Assistant +- Context-aware conversations +- Response caching +- Rate-limit management +- Analytics + +--- + +## Phase 3 — Learning Experience + +**Status:** 🔜 Planned + +### Goals + +- Topic progress tracking +- Learning history +- Bookmarks +- Personalized dashboard +- Revision mode +- Question practice +- Smart recommendations +- Study sessions +- Revision reminders + +--- + +## Phase 4 — Content Platform + +**Status:** 🔜 Planned + +### Goals + +- Rich syllabus management +- Previous Year Question pipeline +- Content versioning +- Content moderation +- Search improvements +- Markdown editor +- Administrative dashboard +- Academic review workflow + +--- + +## Phase 5 — Multi-University Support + +**Status:** 🔜 Planned + +### Goals + +- University abstraction layer +- Multiple curricula +- University-specific syllabus +- University-specific PYQs +- Faculty management +- Content localization + +--- + +## Phase 6 — Analytics & Intelligence + +**Status:** 🔜 Planned + +### Goals + +- Learning analytics +- Student insights +- AI performance metrics +- Content usage statistics +- Search analytics +- Question popularity +- Recommendation engine + +--- + +## Phase 7 — Platform Ecosystem + +**Status:** 🔜 Future + +### Goals + +- Mobile application +- Offline learning +- Notifications +- Collaboration tools +- AI tutor improvements +- Real-time learning sessions +- Community contributions +- Plugin architecture + +--- + +# Technical Roadmap + +## Infrastructure + +- Improve caching +- Streaming AI responses +- Better error handling +- Monitoring +- Logging +- Performance optimization + +--- + +## Developer Experience + +- Unit testing +- Integration testing +- End-to-end testing +- Better documentation +- Architecture documentation +- API documentation +- Developer tooling + +--- + +## Security + +- Authentication improvements +- Authorization policies +- Security auditing +- Rate limiting +- API hardening +- Secret management +- Dependency monitoring + +--- + +# Community Goals + +We want Hyper Learning Tech to become an open-source platform where students and developers collaborate to improve education. + +Future community initiatives include: + +- Contributor onboarding +- Issue mentoring +- Good First Issues +- Documentation improvements +- Community discussions +- Hackathon participation + +--- + +# How You Can Contribute + +Community contributions are always welcome. + +Examples include: + +- Bug fixes +- Documentation +- Accessibility improvements +- Performance optimizations +- UI/UX improvements +- AI enhancements +- Testing +- Academic content + +Please read **CONTRIBUTING.md** before opening a Pull Request. + +--- + +# Roadmap Disclaimer + +This roadmap represents the current direction of the project and is **not a guarantee** of future releases or timelines. + +Priorities may change based on: + +- Community feedback +- Educational requirements +- Technical constraints +- Contributor availability +- Platform growth + +--- + +# Thank You + +Thank you for supporting **Hyper Learning Tech**. + +Whether you're fixing bugs, improving documentation, enhancing AI capabilities, or helping students learn more effectively, your contributions help move the project forward.