mirror of
https://github.com/TheAlgorithms/JavaScript.git
synced 2025-07-05 16:26:47 +08:00
docs: add new issue templates (#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
This commit is contained in:
41
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
41
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
@ -0,0 +1,41 @@
|
||||
name: Bug report
|
||||
description: 'Create a report to help us improve'
|
||||
title: '[BUG]: '
|
||||
labels: ['bug']
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
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).'
|
||||
- type: textarea
|
||||
id: description
|
||||
attributes:
|
||||
label: Description
|
||||
description: Explain what the problem is.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: expectedbhv
|
||||
attributes:
|
||||
label: Expected Behavior
|
||||
description: Describe what was the expected behavior.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: actualbhv
|
||||
attributes:
|
||||
label: Actual Behavior
|
||||
description: Describe what actually happens.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: steps
|
||||
attributes:
|
||||
label: Steps to reproduce (if applicable)
|
||||
description: List steps to reproduce the behavior.
|
||||
placeholder: |
|
||||
1.
|
||||
2.
|
||||
3.
|
||||
4.
|
||||
validations:
|
||||
required: false
|
31
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
31
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
@ -0,0 +1,31 @@
|
||||
name: Feature request
|
||||
description: 'Suggest features, propose improvements, discuss new ideas'
|
||||
title: '[FEATURE]: '
|
||||
labels: ['enhancement']
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
## This issue template is not for requesting new algorithms. For new algorithms, PRs should be opened directly.
|
||||
## Make sure your issue isn't a duplicate and you follow our [contributing guidelines](https://github.com/TheAlgorithms/JavaScript/blob/master/CONTRIBUTING.md)
|
||||
- type: textarea
|
||||
id: description
|
||||
attributes:
|
||||
label: Motivation
|
||||
description: Describe what is the motivation behind this feature.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: examples
|
||||
attributes:
|
||||
label: Examples
|
||||
description: If possible, provide examples of how this feature can be used.
|
||||
validations:
|
||||
required: false
|
||||
- type: textarea
|
||||
id: workarounds
|
||||
attributes:
|
||||
label: Possible workarounds
|
||||
description: If possible, describes possible workarounds to this feature.
|
||||
validations:
|
||||
required: false
|
Reference in New Issue
Block a user