Skip to content

chore: add GitHub issue templates#1517

Merged
spomichter merged 3 commits intodevfrom
summer/chore/issue-templates
Mar 11, 2026
Merged

chore: add GitHub issue templates#1517
spomichter merged 3 commits intodevfrom
summer/chore/issue-templates

Conversation

@SUMMERxYANG
Copy link
Contributor

Problem

No structured issue templates — bug reports lack consistent information (robot model, firmware, OS, commit hash, repro steps).

Solution

Add GitHub issue templates:

  • Bug report — structured form with robot model dropdown, firmware version, commit hash, OS, description, repro steps, and logs
  • Feature request — problem, proposed solution, alternatives, additional context
  • config.yml — disables blank issues, links to Discord

Breaking Changes

None

How to Test

  1. Go to https://github.com/dimensionalOS/dimos/issues/new/choose after merge
  2. Verify both templates render correctly
  3. Verify blank issues are disabled and Discord link appears

Contributor License Agreement

  • I have read and approved the CLA.

@greptile-apps
Copy link
Contributor

greptile-apps bot commented Mar 10, 2026

Greptile Summary

This PR adds three GitHub issue template files that introduce structured forms for bug reports and feature requests, and disables blank issues while linking to the project Discord.

Key changes:

  • bug_report.yml: Structured bug report form with robot model dropdown, firmware version, commit hash, OS, description, repro steps, and optional logs — well suited for the robotics hardware context
  • feature_request.yml: Feature request form covering problem, proposed solution, alternatives, and additional context
  • config.yml: Disables blank issues and surfaces a Discord community link on the issue chooser page

Issues found:

  • The Discord vanity URL https://discord.gg/dimos should be verified as an active, claimed invite slug before merging — an unclaimed vanity URL will result in a broken community link
  • Both templates are missing an optional title prefix field (e.g. [Bug]: / [Feature]: ), which helps maintainers triage issues without extra steps

Confidence Score: 4/5

  • Safe to merge after confirming the Discord vanity URL is active.
  • Changes are purely additive GitHub metadata files with no impact on code or runtime behaviour. The templates are well-structured and appropriate for the project. The one functional concern is the Discord vanity URL, which could produce a broken community support link if the slug is not claimed — this is worth confirming before merge.
  • config.yml — verify the Discord vanity URL resolves correctly.

Important Files Changed

Filename Overview
.github/ISSUE_TEMPLATE/bug_report.yml New structured bug report template with robot model dropdown, firmware version, commit hash, OS, description, repro steps, and logs fields. Well-formed YAML; minor improvement: missing title prefix field.
.github/ISSUE_TEMPLATE/config.yml Disables blank issues and adds a Discord contact link. The vanity URL https://discord.gg/dimos needs verification — it will 404 if the Discord server hasn't claimed this slug.
.github/ISSUE_TEMPLATE/feature_request.yml New feature request template with Problem, Proposed Solution, Alternatives Considered, and Additional Context fields. Clean structure; missing title prefix field (same as bug report).

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A([Contributor clicks 'New Issue']) --> B{config.yml:\nblank_issues_enabled: false}
    B --> C[Issue Chooser Page]
    C --> D[Bug Report template]
    C --> E[Feature Request template]
    C --> F[Discord link\nhttps://discord.gg/dimos]

    D --> D1[Robot Model dropdown\nrequired]
    D1 --> D2[Firmware Version\nrequired]
    D2 --> D3[Commit Hash\nrequired]
    D3 --> D4[OS\nrequired]
    D4 --> D5[Description\nrequired]
    D5 --> D6[Steps to Reproduce\nrequired]
    D6 --> D7[Logs / Error Output\noptional]
    D7 --> D8[Additional Context\noptional]
    D8 --> SUBMIT1([Submit — labelled 'bug'])

    E --> E1[Problem\nrequired]
    E1 --> E2[Proposed Solution\nrequired]
    E2 --> E3[Alternatives Considered\noptional]
    E3 --> E4[Additional Context\noptional]
    E4 --> SUBMIT2([Submit — labelled 'enhancement'])
Loading

Last reviewed commit: 970c9da

id: robot-model
attributes:
label: Robot Model
description: Which robot are you using?
Copy link
Member

Choose a reason for hiding this comment

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

I wouldn't force ask this. People can run it without any robot.

The "steps to reproduce" will/should contain the robot if they use one

@spomichter spomichter merged commit 6546826 into dev Mar 11, 2026
12 checks passed
@spomichter spomichter deleted the summer/chore/issue-templates branch March 11, 2026 07:56
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.

3 participants