Skip to content

Commit

Permalink
Update issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
justinh-rahb authored Aug 1, 2023
1 parent 08393e7 commit b69db9e
Show file tree
Hide file tree
Showing 2 changed files with 53 additions and 42 deletions.
66 changes: 38 additions & 28 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,38 @@
🐛 **Bug Report**

**Description:**
[Provide a clear and concise description of the bug you encountered.]

**Steps to Reproduce:**
1. [Outline the steps you took that led to the bug. Be specific and include any relevant details, such as input data or configuration settings.]

**Expected Behavior:**
[Explain what you expected to happen when following the steps above.]

**Actual Behavior:**
[Describe what actually happened. If there was an error message, include it here.]

**Screenshots / Code Snippets:**
[If applicable, include any relevant screenshots or code snippets that demonstrate the issue.]

**Environment:**
- Operating System: [e.g., Windows 10, macOS Big Sur, Ubuntu 20.04, etc.]
- Browser (if applicable): [e.g., Chrome, Firefox, Safari, etc.]
- Application/Software Version: [e.g., Chat²GPT version or commit hash]
- OpenAI API Version (if applicable): [e.g., gpt-3.5-turbo]

**Additional Information:**
[Include any other relevant information that might help understand or troubleshoot the issue.]

**Possible Solution (Optional):**
[If you have any ideas on how to fix the bug, you can suggest a possible solution here.]
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

**Smartphone (please complete the following information):**
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]

**Additional context**
Add any other context about the problem here.
29 changes: 15 additions & 14 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,20 @@
🚀 **Feature Request**
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''

**Description:**
[Provide a clear and concise description of the new feature you'd like to see added.]
---

**Problem Statement:**
[Explain the problem or need that this feature would address. Describe the context and why the feature would be beneficial.]
**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Proposed Solution:**
[Offer your ideas on how this feature could be implemented or any suggestions on how it could work.]
**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Benefits:**
[Highlight the potential benefits of adding this feature to the project.]
**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional Context:**
[Include any additional information or context that might be relevant to the feature request.]

**Screenshots / Mockups (Optional):**
[If applicable, include any visual aids, such as screenshots or mockups, to help illustrate your idea.]
**Additional context**
Add any other context or screenshots about the feature request here.

0 comments on commit b69db9e

Please sign in to comment.