Skip to content
This repository was archived by the owner on Jul 2, 2024. It is now read-only.

Commit 9d4adbb

Browse files
zendranmzendranm
authored
docs: add new issue templates (TheAlgorithms#1206)
* Adding new issue template * Adding bug issue template * Adding feature request template * Removing feature request template and adding comments * Converting bug template to yaml * Adding new feature request template * CR changes part 1 * CR changes part 2 * CR changes part 3 * CR changes part 4 * CR changes part 5 * Removing specifications section
1 parent 640abcf commit 9d4adbb

File tree

2 files changed

+72
-0
lines changed

2 files changed

+72
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: Bug report
2+
description: 'Create a report to help us improve'
3+
title: '[BUG]: '
4+
labels: ['bug']
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: '### Before you open an issue, please verify if a similar one already exists or has been closed before. More details about the process of contributing can be found in [CONTRIBUTING.md](https://github.com/TheAlgorithms/JavaScript/blob/master/CONTRIBUTING.md).'
9+
- type: textarea
10+
id: description
11+
attributes:
12+
label: Description
13+
description: Explain what the problem is.
14+
validations:
15+
required: true
16+
- type: textarea
17+
id: expectedbhv
18+
attributes:
19+
label: Expected Behavior
20+
description: Describe what was the expected behavior.
21+
validations:
22+
required: true
23+
- type: textarea
24+
id: actualbhv
25+
attributes:
26+
label: Actual Behavior
27+
description: Describe what actually happens.
28+
validations:
29+
required: true
30+
- type: textarea
31+
id: steps
32+
attributes:
33+
label: Steps to reproduce (if applicable)
34+
description: List steps to reproduce the behavior.
35+
placeholder: |
36+
1.
37+
2.
38+
3.
39+
4.
40+
validations:
41+
required: false

‎.github/ISSUE_TEMPLATE/feature_request.yml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: Feature request
2+
description: 'Suggest features, propose improvements, discuss new ideas'
3+
title: '[FEATURE]: '
4+
labels: ['enhancement']
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
## This issue template is not for requesting new algorithms. For new algorithms, PRs should be opened directly.
10+
## Make sure your issue isn't a duplicate and you follow our [contributing guidelines](https://github.com/TheAlgorithms/JavaScript/blob/master/CONTRIBUTING.md)
11+
- type: textarea
12+
id: description
13+
attributes:
14+
label: Motivation
15+
description: Describe what is the motivation behind this feature.
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: examples
20+
attributes:
21+
label: Examples
22+
description: If possible, provide examples of how this feature can be used.
23+
validations:
24+
required: false
25+
- type: textarea
26+
id: workarounds
27+
attributes:
28+
label: Possible workarounds
29+
description: If possible, describes possible workarounds to this feature.
30+
validations:
31+
required: false

0 commit comments

Comments
 (0)