Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
123 changes: 123 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -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
77 changes: 77 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -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
110 changes: 110 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -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
78 changes: 78 additions & 0 deletions .github/ISSUE_TEMPLATE/question.yml
Original file line number Diff line number Diff line change
@@ -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
Loading