Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve the Issue Templates #2375

Merged
merged 5 commits into from
Apr 18, 2023
Merged

Improve the Issue Templates #2375

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7286ef3
Spruced up the bug issue template
sadmuphin Apr 18, 2023
0c8467c
Update 1.bug.yml
sadmuphin Apr 18, 2023
c846c1d
Fixed and added suggestions to bugs template
sadmuphin Apr 18, 2023
7a6eb19
Fixed bugs template and added suggestions
sadmuphin Apr 18, 2023
17caf22
Slight fixes
sadmuphin Apr 18, 2023
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
35 changes: 31 additions & 4 deletions .github/ISSUE_TEMPLATE/1.bug.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@ name: Bug report 🐛
description: Create a bug report for Auto-GPT.
labels: ['status: needs triage']
body:
- type: markdown
attributes:
value: |
⚠️ ### Before you continue
sadmuphin marked this conversation as resolved.
Show resolved Hide resolved
Before you create this issue please join the [discord](https://discord.gg/autogpt) to discuss with our incredible members
about your issue. You are more than welcome to specify your issue in the [tech-support](https://discord.com/channels/1092243196446249134/1092275629602394184) channel.
- type: checkboxes
attributes:
label: ⚠️ Search for existing issues first ⚠️
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- type: checkboxes
attributes:
label: ⚠️ Search for existing issues first ⚠️
- type: markdown
attributes:
value: '### ⚠️ Search for existing issues first ⚠️'
- type: checkboxes
attributes:

Copy link
Member

Choose a reason for hiding this comment

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

Could you still add this? Right now the preview-popup for all issues is "⚠️ Search for existing issues f..." because that label/header is included in the submitted issue. Moving that header to a markdown item fixes that.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Wait I though I changed it. Guess it didn't get pushed. One sec

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Is label a required property? @Pwuts

Copy link
Member

Choose a reason for hiding this comment

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

Yes, it seems to be. My bad. https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#checkboxes

Expand All @@ -28,14 +34,25 @@ body:
- Provide commit-hash (`git rev-parse HEAD` gets it)
- If it's a pip/packages issue, provide pip version, python version
- If it's a crash, provide traceback.
- type: checkboxes
- type: dropdown
attributes:
label: Which Operating System are you using?
description: >
Please select the operating system you were using to run Auto-GPT when this problem occurred.
options:
- Windows
- Linux
- MacOS
- Other (Please specify in your problem)
sadmuphin marked this conversation as resolved.
Show resolved Hide resolved
- type: dropdown
attributes:
label: GPT-3 or GPT-4
description: >
If you are using Auto-GPT with `--gpt3only`, your problems may be caused by
the limitations of GPT-3.5
the limitations of GPT-3.5.
sadmuphin marked this conversation as resolved.
Show resolved Hide resolved
options:
- label: I am using Auto-GPT with GPT-3 (GPT-3.5)
- GPT-3.5
- GPT-4
- type: textarea
attributes:
label: Steps to reproduce 🕹
Expand All @@ -53,8 +70,18 @@ body:
attributes:
label: Your prompt 📝
description: |
sadmuphin marked this conversation as resolved.
Show resolved Hide resolved
If applicable please provide the prompt you are using. You can find your last-used prompt in last_run_ai_settings.yaml.
If applicable please provide the prompt you are using. Your prompt is stored in your `ai_settings.yaml` file.
value: |
```yaml
# Paste your prompt here
```
- type: textarea
attributes:
label: Your Logs 📒
description: |
If applicable please include your error logs. You can find them at `logs/error.log`.
This will help us understand your issue better!
sadmuphin marked this conversation as resolved.
Show resolved Hide resolved
value: |
```
<insert your logs here>
```
sadmuphin marked this conversation as resolved.
Show resolved Hide resolved