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.

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

Add 2 issue templates #27

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
123 changes: 123 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
name: Bug Report
description: Create a report to identify and fix a bug
title: "Bug: "
labels: ["bug", "gitauto"]
# assignees: [""]

body:
- type: textarea
id: bug_behavior
attributes:
label: Bug Behavior
description: What is the bug? What is currently happening?
placeholder: "Example: 'When I try to upload a file (over 100MB), the process fails with a timeout error. This disrupts my workflow and causes delays in my project.'"
validations:
required: true

- type: textarea
id: logs
attributes:
label: Logs
description: Include any logs such as error objects, stack traces, or console logs.
placeholder: "Example: 'Error: TimeoutError: The request timed out after 30 seconds'"
validations:
required: true

- type: textarea
id: screenshots
attributes:
label: Screenshots
description: Add any screenshots such as error messages or unexpected behavior.
placeholder: "Attach it here"
validations:
required: false

- type: input
id: when_it_occurred
attributes:
label: When It Occurred
description: When did the issue last occur?
placeholder: "Example: 'Jul 10, 2024 12:08:00 AM UTC'"
validations:
required: true

- type: textarea
id: steps_to_reproduce
attributes:
label: Steps to Reproduce
description: How can we reproduce the bug?
placeholder: |
Example:
1. Go to "Upload"
2. Click on "Select File"
3. Choose a large file (over 100MB)
4. Click "Upload"
5. See error
value: |
1.
validations:
required: true

- type: textarea
id: expected_behavior
attributes:
label: Expected Behavior
description: What do you expect to happen?
placeholder: "Example: 'The file should upload successfully without any errors even if it's over 100MB.'"
validations:
required: true

- type: textarea
id: possible_cause
attributes:
label: Possible Cause
description: If you have any idea what might be causing the issue, describe it.
placeholder: "Example: 'The issue may be related to the new file upload library introduced in version 1.2.3.'"
validations:
required: false

- type: input
id: device
attributes:
label: Device
description: Describe your device or server.
placeholder: "MacBook Pro, 14-inch, 2023 (Check in 'About This Mac')"
validations:
required: true

- type: input
id: os
attributes:
label: OS
description: |
Describe your operating system.
- For Mac, check in "About This Mac".
- For Windows, check in "Settings" > "System" > "About".
- For iOS, check in "Settings" > "General" > "About" > "iOS Version".
- For Linux, run `uname -a` in the terminal.
- For your server, specify the provider such as AWS EC2, AWS Lambda, or etc.
placeholder: "Sonoma 14.5"
validations:
required: true

- type: input
id: browser
attributes:
label: Browser
description: |
Describe your browser.
- For Chrome, "Chrome, Version 126.0.6478.127 (Official Build) (arm64)". Check in "3 dots" on the top right > "Help" > "About Google Chrome".
- For Safari, "Safari, Version 17.5 (19618.2.12.11.6)". Check in "Safari" on the top left > "About Safari".
- For non-browser issues, type "Server-side" or "Mobile App".
placeholder: "Chrome, Version 126.0.6478.127 (Official Build) (arm64)"
validations:
required: true

- type: textarea
id: additional_information
attributes:
label: Additional Information
description: Include any other context or information.
placeholder: "Describe it here"
validations:
required: false
51 changes: 51 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
name: Feature Request
description: Share your problem and suggest a new feature
title: "Feature Request: "
labels: ["enhancement", "gitauto"]
# assignees: [""]

body:
- type: textarea
id: problem
attributes:
label: Problem
description: What issue are you facing?
placeholder: "Example: 'When I try to upload large files (over 100MB), the process succeeds but takes more than 10 minutes. This disrupts my workflow and causes delays in my project.'"
validations:
required: true

- type: textarea
id: current_solution
attributes:
label: Current Solution
description: How are you currently solving this problem?
placeholder: "Example: 'To work around this, I'm splitting the files into smaller parts (less than 50MB each) and uploading them individually. This is time-consuming and mistake-prone.'"
validations:
required: true

- type: textarea
id: proposed_solution
attributes:
label: Proposed Solution
description: What do you want to happen?
placeholder: "Example: 'I would like a feature that supports seamless uploading of large files, more than 100MB, without any timeouts or delays. This will help me save time and improve my productivity.'"
validations:
required: true

- type: textarea
id: attachments
attributes:
label: Screenshots or Diagrams
description: Add any screenshots or diagrams that can help us understand the feature request.
placeholder: "Attach it here"
validations:
required: false

- type: textarea
id: additional_information
attributes:
label: Additional Information
description: Include any other information or screenshots.
placeholder: "Describe it here"
validations:
required: false
Loading