Skip to content

Commit

Permalink
Add GitHub issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
senko committed Dec 24, 2023
1 parent a6bd846 commit a1fb2af
Show file tree
Hide file tree
Showing 3 changed files with 122 additions and 0 deletions.
45 changes: 45 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: Bug Report
description: File a bug report
title: "[Bug]: "
labels:
- bug
body:
- type: markdown
attributes:
value: |
Thank you for taking the time to fill out this bug report!
If you haven't already, please also check [currently open issues](https://github.com/Pythagora-io/gpt-pilot/issues/) to see if the problem you have is already mentioned. If so, please comment on the the existing issue instead of creating a new one.
We also have an [active community on Discord](https://discord.gg/HaqXugmxr9). If the issue is more about how to do something with GPT Pilot and not about a bug or problem, consider joining our Discord and discussing there, as it's possible other community members could help you!
- type: dropdown
id: client
attributes:
label: Version
description: Which version of GPT Pilot are you using?
options:
- VisualStudio Code extension
- Command-line (Python) version
validations:
required: true
- type: dropdown
id: os
attributes:
label: Operating System
description: Which operating system are you using?
options:
- Windows 10
- Windows 11
- MacOS
- Ubuntu Linux
- Linux (other)
validations:
required: true
- type: textarea
id: what-happened
attributes:
label: What happened?
description: Please describe the problem in as much detail as possible. If you have screenshots or screen recordings, please add them - they will help us figure out what's going on.
placeholder: "When I do [something], [a strange thing or a bug] happens instead of [what I expected]."
validations:
required: true
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: Feature request
description: Suggest a feature or improvement
title: "[Enhancement]: "
labels:
- enhancement
body:
- type: markdown
attributes:
value: |
Thank you for taking the time to suggest improvement to GPT Pilot!
If you haven't already, please also check [currently open issues](https://github.com/Pythagora-io/gpt-pilot/issues/) to see if this is a commonly-asked feature. If so, please comment on the the existing issue instead of creating a new one.
We also have an [active community on Discord](https://discord.gg/HaqXugmxr9), so please consider joining and sharing your idea with the rest of the community.
- type: dropdown
id: client
attributes:
label: Version
description: Which version of GPT Pilot does this apply?
options:
- VisualStudio Code extension
- Command-line (Python) version
validations:
required: true
- type: textarea
id: idea
attributes:
label: Suggestion
description: Please describe your suggestion for the improvement or new feature here.
placeholder: "It would be cool if GPT Pilot could do [something]."
validations:
required: true
45 changes: 45 additions & 0 deletions .github/ISSUE_TEMPLATE/howto.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: How do I...?
description: Ask for help if you're stuck
title: "[Howto]: "
labels:
- question
body:
- type: markdown
attributes:
value: |
Thanks for trying out GPT Pilot!
In general, it's best to ask the question [in our community Discord](https://discord.gg/HaqXugmxr9). We have an active and friendly community and you will likely get an answer quicker than if you post here. You can also check our [open issues](https://github.com/Pythagora-io/gpt-pilot/issues/) and see if what you're asking about was already discussed there.
BTW: If you're wondering how to use GPT Pilot with a local LLM, please check our tutorial here: [Using GPT Pilot with Local LLMs](https://github.com/Pythagora-io/gpt-pilot/wiki/Using-GPT%E2%80%90Pilot-with-Local-LLMs).
- type: dropdown
id: client
attributes:
label: Version
description: Which version of GPT Pilot are you using?
options:
- VisualStudio Code extension
- Command-line (Python) version
validations:
required: true
- type: dropdown
id: os
attributes:
label: Operating System
description: Which operating system are you using?
options:
- Windows 10
- Windows 11
- MacOS
- Ubuntu Linux
- Linux (other)
validations:
required: true
- type: textarea
id: question
attributes:
label: Your question
description: Please describe your question in as much detail as possible.
placeholder: "How can I do [something] with GPT Pilot? I've checked the open issues and Discord and there doesn't seem to be an answer to this."
validations:
required: true

0 comments on commit a1fb2af

Please sign in to comment.