Add troubleshooting document and issue template (#1243)

* add troubleshooting doc * add link to troubleshooting * mark required * unmark required * more required stuff * add nonetype issue * Update .github/ISSUE_TEMPLATE/bug_template.yml Co-authored-by: Boxuan Li <liboxuan@connect.hku.hk> * Update .github/ISSUE_TEMPLATE/bug_template.yml --------- Co-authored-by: Boxuan Li <liboxuan@connect.hku.hk>
2026-01-08 22:38:05 -05:00 · 2024-04-20 09:05:45 -04:00
parent 0356f6ec89
commit 3c85ece23e
4 changed files with 143 additions and 42 deletions
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -1,41 +0,0 @@
---
-name: Bug Report
-about: Report a problem with OpenDevin
-title: ''
-labels: 'bug'
-assignees: ''
-
---
-<!-- You MUST fill out this template. We will close issues that don't include enough information to reproduce -->
-#### Describe the bug
-<!-- a short description of the problem -->
-
-#### Setup and configuration
-**Current version**:
-<!-- run `git log -n 1` to see this -->
-```bash
-```
-
-**My operating system**:
-
-<!-- tell us everything about your environment -->
-**My environment vars and other configuration** (be sure to redact API keys):
-```bash
-```
-
-**My model and agent** (you can see these settings in the UI):
-* Model:
-* Agent:
-
-**Commands I ran to install and run OpenDevin**:
-```
-```
-
-**Steps to Reproduce**:
-1.
-2.
-3.
-
-**Logs, error messages, and screenshots**:
-
-#### Additional Context
--- a/.github/ISSUE_TEMPLATE/bug_template.yml
+++ b/.github/ISSUE_TEMPLATE/bug_template.yml
@@ -0,0 +1,69 @@
+name: Bug
+description: Report a problem with OpenDevin
+title: '[Bug]: '
+labels: ['bug']
+body:
+  - type: markdown
+    attributes:
+      value: Thank you for taking the time to fill out this bug report. We greatly appreciate your effort to complete this template fully. Please provide as much information as possible to help us understand and address the issue effectively.
+
+  - type: checkboxes
+    attributes:
+      label: Is there an existing issue for the same bug?
+      description: Please check if an issue already exists for the bug you encountered.
+      options:
+      - label: I have checked the troubleshooting document at https://github.com/OpenDevin/OpenDevin/blob/main/docs/guides/Troubleshooting.md
+        required: true
+      - label: I have checked the existing issues.
+        required: true
+
+  - type: textarea
+    id: bug-description
+    attributes:
+      label: Describe the bug
+      description: Provide a short description of the problem.
+    validations:
+      required: true
+
+  - type: textarea
+    id: current-version
+    attributes:
+      label: Current Version
+      description: What version are you using? If you're running in docker, tell us the tag you're using (e.g. ghcr.io/opendevin/opendevin:0.3.1).
+      render: bash
+    validations:
+      required: true
+
+  - type: textarea
+    id: config
+    attributes:
+      label: Installation and Configuration
+      description: Please provide any commands you ran and any configuration (redacting API keys)
+      render: bash
+    validations:
+      required: true
+
+  - type: textarea
+    id: model-agent
+    attributes:
+      label: Model and Agent
+      description: What model and agent are you using? You can see these settings in the UI by clicking the settings wheel.
+      placeholder: |
+        - Model:
+        - Agent:
+
+  - type: textarea
+    id: repro-steps
+    attributes:
+      label: Reproduction Steps
+      description: Please list the steps to reproduce the issue.
+      placeholder: |
+        1.
+        2.
+        3.
+
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Logs, Errors, Screenshots, and Additional Context
+      description: Please add any additional context about the problem here.