Skip to content

Commit

Permalink
docs(template): improve issue templates
Browse files Browse the repository at this point in the history
Signed-off-by: slasher <[email protected]>
  • Loading branch information
sejust committed Aug 16, 2023
1 parent 4ba5ab6 commit 3d9f15e
Show file tree
Hide file tree
Showing 7 changed files with 230 additions and 44 deletions.
23 changes: 0 additions & 23 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

107 changes: 107 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
name: Bug report
description: Create a bug report to help us improve CubeFS
title: "[Bug]: "
labels: [bug]
assignees:
- xiaochunhe
- leonrayang

body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
Any questions can be asked in our WeChat group.
- type: input
id: contact
attributes:
label: Contact Details
description: How can we get in touch with you if we need more info?
placeholder: [email protected]
validations:
required: false

- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists of the bug.
options:
- label: I have searched all the existing issues
required: true

- type: dropdown
id: priority
attributes:
label: Priority
description: Which the priority you think?
options:
- low (Default)
- high
- fatal
default: 0
validations:
required: true

- type: textarea
attributes:
label: Environment
description: |
Please enter the Environment Details:
value: |
- CubeFS version:
- Deployment mode(docker or standalone or cluster):
- Dependent components:
- OS kernel version(Ubuntu or CentOS):
- CPU/Memory:
- Others:
render: markdown
validations:
required: true

- type: textarea
attributes:
label: Current Behavior
description: A concise description of what you're experiencing.
placeholder: |
When I do <X>, <Y> happens and I see the error message attached below:
```...```
validations:
required: true

- type: textarea
attributes:
label: Expected Behavior
description: A concise description of what you expected to happen.
placeholder: When I do <X>, <Z> should happen instead.
validations:
required: false

- type: textarea
attributes:
label: Steps To Reproduce
description: Steps to reproduce the behavior.
placeholder: |
1. Init environment ...
2. Install CubeFS with version ...
3. With those config ...
4. Then run this '...'
5. See error ...
render: markdown
validations:
required: false

- type: textarea
attributes:
label: CubeFS Log
description: Detailed error log information is helpful for finding problems.
validations:
required: false

- type: textarea
attributes:
label: Anything else? (Additional Context)
description: |
Links? References? Anything that will give us more context about the issue you are encountering!
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: Ask a question
url: https://github.com/cubefs/cubefs/discussions
about: Ask questions and discuss with other community members
54 changes: 54 additions & 0 deletions .github/ISSUE_TEMPLATE/enhancement.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
name: Enhancement request
description: As a developer, I want to make an enhancement for CubeFS
title: "[Enhancement]: "
labels: [enhancement]
assignees:
- xiaochunhe
- leonrayang

body:
- type: markdown
attributes:
value: |
Thanks for taking the time to request/suggest an enhancement for CubeFS!
- type: input
id: contact
attributes:
label: Contact Details
description: How can we get in touch with you if we need more info?
placeholder: [email protected]
validations:
required: false

- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue related to this already exists.
options:
- label: I have searched all the existing issues
required: true

- type: textarea
attributes:
label: What would you like to be added?
description: A concise description of what you're expecting/suggesting.
placeholder: |
I would like to suggest/request a feature that's like...
validations:
required: true

- type: textarea
attributes:
label: Why is this needed?
description: A concise description of the reason/motivation
validations:
required: false

- type: textarea
attributes:
label: Anything else?
description: |
Links? References? Screenshots? Anything that will give us more context about this!
validations:
required: false
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

61 changes: 61 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
name: Feature request
description: As a user, I want to request a feature for CubeFS
title: "[Feature]: "
labels: [enhancement]
assignees:
- xiaochunhe
- leonrayang

body:
- type: markdown
attributes:
value: |
Thanks for taking the time to request a feature for CubeFS!
- type: input
id: contact
attributes:
label: Contact Details
description: How can we get in touch with you if we need more info?
placeholder: [email protected]
validations:
required: false

- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue related to this feature request already exists.
options:
- label: I have searched all the existing issues
required: true

- type: textarea
attributes:
label: Is your feature request related to a problem? Please describe.
description: A concise description of the problem you are facing or the motivetion behind this feature request.
placeholder: |
I faced a problem due to which ...
validations:
required: true

- type: textarea
attributes:
label: Describe the solution you'd like.
description: A concise description of the solution for the issue.
validations:
required: false

- type: textarea
attributes:
label: Describe an alternate solution.
description: Is there any other approack to solve the problem?
validations:
required: false

- type: textarea
attributes:
label: Anything else? (Additional Context)
description: |
Links? References? Anything that will give us more context about this!
validations:
required: false
4 changes: 3 additions & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@

**What this PR does / why we need it**:

**Which issue this PR fixes** *(optional, in `fixes #<issue number>(, fixes #<issue_number>, ...)` format, will close that issue when PR gets merged)*: fixes #
**Which issue this PR fixes**:
<!-- *(optional, in `fixes #<issue number>(, fixes #<issue_number>, ...)` format, will close that issue when PR gets merged)*: -->
fixes #

**Special notes for your reviewer**:

Expand Down

0 comments on commit 3d9f15e

Please sign in to comment.