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

Update issue templates #803

Merged
merged 4 commits into from
Dec 7, 2023
Merged
Show file tree
Hide file tree
Changes from 3 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
46 changes: 0 additions & 46 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

94 changes: 94 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
name: Bug Report
description: File a bug report
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
Note: Please search to see if an issue already exists for the bug you encountered.
- type: textarea
id: current-behavior
attributes:
label: Current Behavior
description: A concise description of what you're experiencing.
placeholder: Tell us what you see!
validations:
required: true
- type: textarea
id: expected-behavior
attributes:
label: Expected Behavior
description: A concise description of what you expected to happen.
placeholder: Tell us what you want to see!
validations:
required: true
- type: textarea
id: steps-to-reproduce
attributes:
label: Steps to Reproduce
description: Detailed steps to reproduce the behavior.
placeholder: |
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
- type: input
id: version
attributes:
label: Version
description: What version of reneterd are you running? If you are running from source, please provide the commit hash.
placeholder: v1.0.0
validations:
required: true
- type: input
id: os
attributes:
label: What operating system did the problem occur on (e.g. Ubuntu 22.04, macOS 12.0, Windows 11)?
validations:
required: true
- type: input
id: apCfg
attributes:
label: Autopilot Config
description: |
The configuration of your autopilot
```bash
curl -u ":[YOUR_PASSWORD]" http://localhost:9980/api/autopilot/config
```
placeholder: Paste the output of the above command here ```
validations:
required: true
- type: input
id: busCfg
attributes:
label: Bus Config
description: |
The configuration of your bus
```bash
curl -u ":[YOUR_PASSWORD]" http://localhost:9980/api/bus/setting/redundancy

curl -u ":[YOUR_PASSWORD]" http://localhost:9980/api/bus/setting/gouging
Copy link
Member

Choose a reason for hiding this comment

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

we have these settings:

	SettingContractSet      = "contractset"
	SettingGouging          = "gouging"
	SettingRedundancy       = "redundancy"
	SettingS3Authentication = "s3authentication"
	SettingUploadPacking    = "uploadpacking"

we should probably ask for every single one except for S3 auth?

```
placeholder: Paste the output of the above commands here
validations:
required: true
- type: input
id: csContracts
attributes:
label: Contract Set Contracts
description: |
The number of contracts in your contract set
```bash
curl -u ":[YOUR_PASSWORD]" http://localhost:9980/api/bus/contracts/set/autopilot | grep '"id"' | wc -l
Copy link
Member

Choose a reason for hiding this comment

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

missing closing ticks

placeholder: Paste the output of the above command here ```
validations:
required: true
- type: textarea
attributes:
label: Anything else?
description: |
Links? References? Anything that will give us more context about the issue you are encountering!
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
validations:
required: false
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Sia Community Discord
url: https://discord.gg/sia
about: Join the Sia community discord for more help with Sia or hostd.
42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: Feature Request
description: Request a new feature be added to renterd.
labels: ["feature"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this feature request!
Note: Please search to see if an issue already exists for the feature
you want added.
- type: textarea
Copy link
Member

Choose a reason for hiding this comment

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

Maybe a dropdown to categorise the feature request is interesting?

- type: dropdown
  id: feature-category
  attributes:
    label: Feature Category
    description: Please select the category that best fits your feature request.
    options:
      - UI/UX Improvement
      - Performance Enhancement
      - New Functionality
      - Security
      - Other
  validations:
    required: true

id: feature-description
attributes:
label: Description
description: |
A description of the feature you want added
Tip: You can attach images by clicking this area and then dragging files in.
placeholder: Tell us what you want! Be as descriptive as possible.
validations:
required: true
- type: input
id: version
attributes:
label: Version
description: What version of renterd are you running?
placeholder: v1.0.0
validations:
required: false
- type: input
id: os
attributes:
label: What operating system are you running (e.g. Ubuntu 22.04, macOS, Windows 11)?
validations:
required: false
- type: textarea
attributes:
label: Anything else?
description: |
Links? References? Anything that will give us more context about the feature!
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
validations:
required: false