Skip to content

Commit 238813e

Browse files
chore : added issue templates and PR templates (DulLabs#128)
Co-authored-by: Aniket Singh <[email protected]>
1 parent 850a924 commit 238813e

File tree

5 files changed

+121
-0
lines changed

5 files changed

+121
-0
lines changed

.github/ISSUE_TEMPLATE/Other.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
name: Other
3+
about: Something else
4+
5+
---
6+

.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: Bug Report
2+
description: Create a report to help us improve
3+
title: "Bug: "
4+
labels: [bug]
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: Thank you for taking the time to file a Bug report.
10+
- type: textarea
11+
attributes:
12+
label: Describe the bug.
13+
description: 'A clear and concise description of what the bug is.'
14+
- type: textarea
15+
attributes:
16+
label: Describe the steps to reproduce the behavior.
17+
description: 'Be clear and concise while describing the steps to ensure that it can be reproduced and potentially fixed'
18+
- type: textarea
19+
attributes:
20+
label: Expected behavior.
21+
description: 'A clear and concise description of what you expected to happen.'
22+
- type: textarea
23+
attributes:
24+
label: Screenshots.
25+
description: 'If applicable, add screenshots to help explain your problem.'
26+
- type: input
27+
attributes:
28+
label: Operating Environment
29+
description: 'What operating system and version are you using? If you are running it on Cloud/Cluster do mention about that.'
30+
validations:
31+
required: true
32+
- type: textarea
33+
attributes:
34+
label: Additional Information
35+
description: 'Any additional information that may help us reproduce the bug.'
36+
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Documentation Update
2+
description: Suggest how we can improve our documentation
3+
title: "Documentation: "
4+
labels: [documentation]
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: Thank you for taking the time to file a Documentation update report.
10+
- type: textarea
11+
attributes:
12+
label: What is the current documentation state?
13+
description: 'Copy and paste the text currently in the documentation. If you want to improve graphs or photos, please provide a screenshot of the original.'
14+
- type: textarea
15+
attributes:
16+
label: Where is this stated?
17+
description: 'Provide additional information about the location where you have copied the above statement from.'
18+
- type: textarea
19+
attributes:
20+
label: Why do you want to improve the statement?
21+
description: 'Please explain why the statement needs to be updated. This can be because it is confusing, incorrect, spelling/grammatical errors, etc.'
22+
- type: textarea
23+
attributes:
24+
label: Proposed Statement
25+
description: 'Please propose how you would rewrite the statement. If you have a precise proposal, please make the changes and open a pull request.'
26+
- type: textarea
27+
attributes:
28+
label: Additional context.
29+
description: 'Add any other context or useful information about the documentation update here.'
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: Feature Request
2+
description: Suggest an idea for this project
3+
title: "Feature Request: "
4+
labels: [enhancement]
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: Thank you for taking the time to file a Feature Request report.
10+
- type: textarea
11+
attributes:
12+
label: Is your feature request related to a problem? Please describe.
13+
description: 'A clear and concise description of what the problem is. Ex. I am always frustrated when [...]'
14+
- type: textarea
15+
attributes:
16+
label: Describe the solution you'd like.
17+
description: 'A clear and concise description of what you want to happen.'
18+
- type: textarea
19+
attributes:
20+
label: Describe alternatives you've considered
21+
description: 'A clear and concise description of any alternative solutions or features you have considered.'
22+
- type: textarea
23+
attributes:
24+
label: Additional context.
25+
description: 'Add any other context or screenshots about the feature request here.'
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: User Feedback
2+
description: Describe how we can improve your experience
3+
title: "User Feedback: "
4+
labels: [user-feedback]
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: Thank you for taking the time to file a User Feedback report.
10+
- type: textarea
11+
attributes:
12+
label: Describe what you are trying to do and why it is not optimal.
13+
description: 'A clear and concise description of what the problem is. Ex. When I reach this point, I cannot [...]'
14+
- type: textarea
15+
attributes:
16+
label: Describe the solution you'd like.
17+
description: 'A clear and concise description of what you want to happen.'
18+
- type: textarea
19+
attributes:
20+
label: Describe alternatives you've considered.
21+
description: 'A clear and concise description of any alternative solutions or features you have considered.'
22+
- type: textarea
23+
attributes:
24+
label: Additional context.
25+
description: 'Add any other context or screenshots about the feature request here.'

0 commit comments

Comments
 (0)