Skip to content
Closed
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
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Issue Templates

This directory contains GitHub Classic Markdown Issue Templates for ArcMind AI.

## Available Templates

| Template | File | Purpose | Default Labels |
|---|---|---|---|
| 🐛 **Bug Report** | [`bug_report.md`](bug_report.md) | Report defects or errors | `bug`, `needs triage` |
| ✨ **Feature Request** | [`feature_request.md`](feature_request.md) | Suggest new features | `enhancement`, `needs triage` |
| 📚 **Documentation** | [`documentation.md`](documentation.md) | Propose doc updates | `documentation`, `needs triage` |
| 🎨 **UI/UX Improvement** | [`ui_ux_improvement.md`](ui_ux_improvement.md) | Propose UI/UX styling enhancements | `ui/ux`, `frontend`, `needs triage` |
| ⚡ **Enhancement & Refactoring** | [`enhancement.md`](enhancement.md) | Propose code refactoring or DX tooling | `enhancement`, `needs triage` |
| 🚀 **Performance Optimization** | [`performance.md`](performance.md) | Report performance bottlenecks | `performance`, `needs triage` |
| 🔒 **Security Vulnerability** | [`security.md`](security.md) | Report security concerns | `security`, `needs triage` |

## Configuration

- Issue chooser links are configured in [`config.yml`](config.yml).
- See [`docs/ISSUE_TEMPLATES.md`](../../docs/ISSUE_TEMPLATES.md) for workflow details and contribution rules.
60 changes: 60 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
---
name: "🐛 Bug Report"
about: Report a defect, error, or unexpected behavior.
title: "[BUG]: "
labels: "bug, needs triage"
assignees: ""
---

<!--
GSSoC 2026 Contributors:
- Comment to request assignment before starting work.
- Search existing issues to avoid duplicate reports.
-->

## 🐛 Description

<!-- Describe the bug clearly. -->

## 🔄 Reproduction Steps

1. Go to '...'
2. Click on '...'
3. See error

## 🎯 Expected Behavior

<!-- Describe what should happen. -->

## 💥 Actual Behavior

<!-- Describe what actually happens. -->

## 💻 Error Logs

```text
<!-- Paste console errors, network responses, or stack traces here. -->
```

## 📸 Screenshots

<!-- Attach screenshots or video recordings. Required for UI defects. -->

## 💻 Environment

- **OS**: [e.g., Windows 11, macOS, Ubuntu]
- **Browser**: [e.g., Chrome, Firefox, Safari]
- **Node.js**: [e.g., v18.17.0, v20.11.0]
- **Package Manager**: [e.g., pnpm v8.15.0]
- **Module**: [e.g., Frontend, API, Database, AI, GitHub OAuth]

## 🔍 Additional Context

<!-- Add any other context or details about the bug. -->

## Checklist

- [ ] I searched existing issues to ensure this is not a duplicate.
- [ ] I included steps to reproduce the issue.
- [ ] I attached relevant logs and environment details.
- [ ] (GSSoC 2026) I will wait for maintainer assignment before starting work.
12 changes: 12 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# ArcMind AI GitHub Issue Helper Configuration

blank_issues_enabled: false

contact_links:
- name: "💬 GSSoC 2026 Discussion & Assignment Channel"
url: "https://github.com/SATYAM-PRATIBHAN/arcmindAI/discussions/120"
about: "Official discussion thread for GSSoC 2026 announcements, issue assignment requests, and Q&A."

- name: "💡 Community Q&A & Idea Brainstorming"
url: "https://github.com/SATYAM-PRATIBHAN/arcmindAI/discussions"
about: "Ask general technical questions, propose open-ended ideas, or showcase your ArcMind AI implementations."
42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
name: "📚 Documentation Improvement"
about: Suggest updates or new content for ArcMind AI documentation.
title: "[DOCS]: "
labels: "documentation, needs triage"
assignees: ""
---

<!--
GSSoC 2026 Contributors:
- Comment to request assignment before starting work.
-->

## 📚 Documentation Type

- [ ] README
- [ ] Installation / Setup Guide
- [ ] Contribution Guidelines
- [ ] API Documentation
- [ ] Architecture / Design Documentation
- [ ] User Guide / Tutorial
- [ ] Code Documentation
- [ ] Examples / Sample Projects
- [ ] Other (please specify)

## 🎯 Target Location

<!-- File path or section needing update (e.g., README.md#installation, docs/api/webhooks.md). -->

## 📝 Proposed Changes

<!-- Describe the changes or additions needed. -->

## ❓ Motivation

<!-- Why is this update needed? (e.g., outdated information, missing step, typo). -->

## Checklist

- [ ] I verified the proposed documentation changes are accurate.
- [ ] I searched existing issues to avoid duplicates.
- [ ] (GSSoC 2026) I will wait for maintainer assignment before starting work.
44 changes: 44 additions & 0 deletions .github/ISSUE_TEMPLATE/enhancement.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
name: "⚡ Enhancement & Refactoring"
about: Propose code refactoring, structural improvements, or developer tooling optimizations.
title: "[ENHANCEMENT]: "
labels: "enhancement, needs triage"
assignees: ""
---

<!--
GSSoC 2026 Contributors:
- Comment to request assignment before starting work.
-->

## ⚡ Enhancement Type

- [ ] Code Refactoring
- [ ] Code Cleanup
- [ ] Architecture Improvement
- [ ] Component Reusability
- [ ] Developer Experience (DX)
- [ ] Build / Tooling
- [ ] Dependency Maintenance
- [ ] Error Handling
- [ ] Performance Improvement
- [ ] Documentation / Internal Developer Docs
- [ ] Other (please specify)

## 🔍 Current Implementation

<!-- Describe existing code debt or limitations with file paths. -->

## 🛠️ Proposed Solution

<!-- Describe the refactoring approach or new structure. -->

## 🎯 Impact

<!-- Expected benefits (e.g., cleaner code, better maintainability, stricter typing). -->

## Checklist

- [ ] I verified this change will not introduce unhandled breaking changes.
- [ ] I searched existing issues to avoid duplicates.
- [ ] (GSSoC 2026) I will wait for maintainer assignment before starting work.
43 changes: 43 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
name: "✨ Feature Request"
about: Suggest a new feature or enhancement for ArcMind AI.
title: "[FEAT]: "
labels: "enhancement, needs triage"
assignees: ""
---

<!--
GSSoC 2026 Contributors:
- Comment to request assignment before starting work.
- Search existing issues and discussions to avoid duplicate proposals.
-->

## ✨ Description

<!-- Summarize the proposed feature. -->

## 💡 Problem Statement

<!-- What problem does this feature solve? -->

## 🚀 Proposed Solution

<!-- Describe how this feature should work. -->

## 🎨 Mockups & UI (If Applicable)

<!-- Attach visual mockups, wireframes, or sketches. -->

## 🛠️ Technical Details

<!-- Note affected components or tech stack details (Next.js, Prisma, Gemini, Redis). -->

## 🔄 Alternatives Considered

<!-- Describe any alternative solutions considered. -->

## Checklist

- [ ] I searched existing issues to ensure this request is unique.
- [ ] I provided a clear problem statement and proposed solution.
- [ ] (GSSoC 2026) I will wait for maintainer assignment before starting work.
46 changes: 46 additions & 0 deletions .github/ISSUE_TEMPLATE/ui_ux_improvement.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
name: "🎨 UI/UX Improvement"
about: Propose visual styling, accessibility, or responsive design enhancements.
title: "[UI/UX]: "
labels: "ui/ux, frontend, needs triage"
assignees: ""
---

<!--
GSSoC 2026 Contributors:
- Comment to request assignment before starting work.
- Pull Requests with UI changes MUST include screenshots or video proof.
-->

## 🎨 Overview

<!-- Summary of the UI/UX enhancement. -->

## 📍 Affected Area

<!-- Specify the affected page, route, or component (e.g., Dashboard, Sidebar, /generate). -->

## 🔍 Current vs. Proposed Behavior

### Current Behavior
<!-- Describe current UI behavior or layout. -->

### Proposed Behavior
<!-- Describe expected UI behavior or layout. -->

## 📸 Screenshots & Mockups

<!-- Attach screenshots, Figma links, or mockups. -->

## ♿ Responsiveness & Accessibility

- [ ] Mobile responsive layout
- [ ] Dark / Light theme support
- [ ] Keyboard navigation & focus states
- [ ] ARIA attributes & screen reader support

## Checklist

- [ ] I attached current screenshots or design references.
- [ ] I understand UI PRs require screenshots or video proof.
- [ ] (GSSoC 2026) I will wait for maintainer assignment before starting work.
84 changes: 14 additions & 70 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,84 +45,28 @@ This project and everyone participating in it is governed by our [Code of Conduc

### Reporting Bugs

Before creating bug reports, please check the existing issues to avoid duplicates. When you create a bug report, include as many details as possible:
Before creating bug reports, please check existing issues to avoid duplicates. When creating a bug report, select the **🐛 Bug Report** template when opening a new issue on GitHub.

- **Use a clear and descriptive title**
- **Describe the exact steps to reproduce the problem**
- **Provide specific examples** to demonstrate the steps
- **Describe the behavior you observed** and what you expected to see
- **Include screenshots or animated GIFs** if applicable
- **Include your environment details**: OS, Node.js version, browser, etc.

**Bug Report Template:**

```markdown
## Bug Description

A clear and concise description of what the bug is.

## Steps to Reproduce

1. Go to '...'
2. Click on '...'
3. Scroll down to '...'
4. See error

## Expected Behavior

What you expected to happen.

## Actual Behavior

What actually happened.

## Screenshots

If applicable, add screenshots to help explain your problem.

## Environment

- OS: [e.g., macOS 14.0]
- Node.js version: [e.g., 18.17.0]
- Browser: [e.g., Chrome 120]
- ArcMind AI version: [e.g., 1.0.0]
For complete guidelines on issue reporting and template details, refer to [`docs/ISSUE_TEMPLATES.md`](docs/ISSUE_TEMPLATES.md).

## Additional Context

Add any other context about the problem here.
```
Key guidelines:
- **Use a clear and descriptive title** starting with `[BUG]: `
- **Describe the exact steps to reproduce the problem**
- **Provide error logs and stack traces** using Markdown code blocks
- **Attach screenshots or screen recordings** for UI defects
- **Include your environment details** (OS, Node.js version, browser, etc.)

### Suggesting Features

Feature suggestions are welcome! Before creating a feature request:
Feature suggestions are welcome! Select the **✨ Feature Request** template when creating an issue.

Before submitting a feature request:
- **Check if the feature has already been suggested**
- **Provide a clear use case** for the feature
- **Explain how it would benefit users**

**Feature Request Template:**

```markdown
## Feature Description

A clear and concise description of the feature you'd like to see.

## Problem Statement
- **Provide a clear problem statement and use case**
- **Detail your proposed solution and architecture impact**
- **Include mockups or UI sketches** where applicable

What problem does this feature solve? Is your feature request related to a problem?

## Proposed Solution

Describe how you envision this feature working.

## Alternatives Considered

Describe any alternative solutions or features you've considered.

## Additional Context

Add any other context, mockups, or screenshots about the feature request here.
```
For documentation, UI/UX, performance, security, and refactoring proposals, please select the corresponding issue template when opening a new issue. See [`docs/ISSUE_TEMPLATES.md`](docs/ISSUE_TEMPLATES.md) for full details.

### Your First Code Contribution

Expand Down