Skip to content

docs: add template#158

Merged
sairin1202 merged 2 commits intomainfrom
issues/add_hackathon_template
Jan 7, 2026
Merged

docs: add template#158
sairin1202 merged 2 commits intomainfrom
issues/add_hackathon_template

Conversation

@sairin1202
Copy link
Contributor

  • add issue template for hackathon
Copilot AI review requested due to automatic review settings January 7, 2026 17:15
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds a GitHub issue template for hackathon tasks, specifically for the "2026 New Year Challenge" memU track. The template provides structured fields for participants to submit hackathon tasks with details about requirements, review criteria, and task specifications.

Key Changes:

  • Adds a new issue template file hackathon_task.yml with form fields for hackathon task submissions
  • Includes fields for task name, description, requirements, review criteria, labels, and assignees

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +1 to +96
name: Hackathon Task
description: The official designated task for the memU track in the 2026 New Year Challenge
title: "[2026NewYearChallenge] "
labels: ["hackathon-task"]
assignees: []
body:
- type: markdown
attributes:
value: |
Thank you for taking the time to join the challenge, and best of luck!

- type: input
id: task_name
attributes:
label: Name
description: The name of this hackathon task.
placeholder: "e.g., Add long-term memory compression for agents"
validations:
required: true

- type: textarea
id: about
attributes:
label: About
description: Brief background / context for the task (why it matters, what problem it solves).
placeholder: "Explain the context and motivation."
validations:
required: true

- type: input
id: hackathon_task
attributes:
label: Hackathon Task
description: The designated track identifier for this challenge.
value: "2026NewYearChallenge"
validations:
required: true

- type: dropdown
id: label_hint
attributes:
label: Label
description: Pick the most appropriate label for this task.
options:
- hackathon-task
- enhancement
- bug
- documentation
- question
validations:
required: true

- type: input
id: assignees_hint
attributes:
label: Assignees
description: GitHub usernames to assign (comma-separated). If empty, maintainers will triage.
placeholder: "e.g., alice,bob"
validations:
required: false

- type: textarea
id: description
attributes:
label: Description*
description: What will this task implement?
placeholder: "Enter a clear and concise description of the task you want to implement."
validations:
required: true

- type: textarea
id: requirements
attributes:
label: Requirements (optional)
description: What will your planned pull request include? (APIs, modules, tests, docs, etc.)
placeholder: |
- [ ] Implementation details
- [ ] Tests
- [ ] Docs / examples
- [ ] Compatibility notes
validations:
required: false

- type: textarea
id: review_criteria
attributes:
label: Review Criteria (optional)
description: How will this task be evaluated?
placeholder: |
Example:
- Correctness (passes tests, no regressions)
- Quality (readability, modularity)
- DX (good docs / examples)
- Impact (useful for memU users)
validations:
required: false
Copy link

Copilot AI Jan 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The entire file has incorrect indentation with leading spaces on every line. GitHub issue template YAML files should not have leading spaces before top-level keys. Remove the leading spaces from all lines to fix the indentation.

Copilot uses AI. Check for mistakes.
Comment on lines +39 to +51
- type: dropdown
id: label_hint
attributes:
label: Label
description: Pick the most appropriate label for this task.
options:
- hackathon-task
- enhancement
- bug
- documentation
- question
validations:
required: true
Copy link

Copilot AI Jan 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The label dropdown field (lines 39-51) is redundant and inconsistent with other issue templates in this repository. The label is already defined at the template level (line 4: labels: ["hackathon-task"]). Other templates like bug_report.yml and feature_request.yml set labels at the template level without asking users to select them again. Remove this dropdown field to maintain consistency with the existing templates.

Copilot uses AI. Check for mistakes.
Comment on lines +53 to +60
- type: input
id: assignees_hint
attributes:
label: Assignees
description: GitHub usernames to assign (comma-separated). If empty, maintainers will triage.
placeholder: "e.g., alice,bob"
validations:
required: false
Copy link

Copilot AI Jan 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The assignees input field (lines 53-60) is inconsistent with other issue templates in this repository. None of the existing templates (bug_report.yml, feature_request.yml, improvement_suggestion.yml) include an assignees field in the form. GitHub issue templates typically don't ask users to assign themselves or others during issue creation, as this is handled through the GitHub UI. Remove this field to maintain consistency with existing templates.

Copilot uses AI. Check for mistakes.
- type: textarea
id: description
attributes:
label: Description*
Copy link

Copilot AI Jan 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The label "Description*" includes an asterisk, which is inconsistent with how required fields are indicated in other templates. The asterisk is redundant since the field already has "required: true" in its validation (line 69). Other templates in this repository use plain labels like "Description" (see bug_report.yml:14, feature_request.yml:14, improvement_suggestion.yml:14). Remove the asterisk to maintain consistency.

Copilot uses AI. Check for mistakes.
description: The official designated task for the memU track in the 2026 New Year Challenge
title: "[2026NewYearChallenge] "
labels: ["hackathon-task"]
assignees: []
Copy link

Copilot AI Jan 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The top-level assignees field is not used in other issue templates in this repository. For consistency with bug_report.yml, feature_request.yml, and improvement_suggestion.yml, this field should be omitted rather than set to an empty array.

Copilot uses AI. Check for mistakes.
@sairin1202 sairin1202 merged commit b79a78d into main Jan 7, 2026
3 checks passed
@sairin1202 sairin1202 deleted the issues/add_hackathon_template branch January 7, 2026 17:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

2 participants