feat: Add contribution templates (#none) (#139)
* feat: Add PR template * feat: Add issue templates * style: Comfort pre-commit * style: Comfort pre-commit
This commit is contained in:
parent
1cdefe7ba3
commit
fcefb80fa6
85
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
85
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
|
@ -0,0 +1,85 @@
|
||||||
|
name: "Bug Report"
|
||||||
|
description: Report something that is not working as expected
|
||||||
|
title: "[BUG] - <title>"
|
||||||
|
labels: ["bug"]
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
*Please fill this form with as much information as possible.*
|
||||||
|
- type: textarea
|
||||||
|
id: description
|
||||||
|
attributes:
|
||||||
|
label: "Description"
|
||||||
|
description: Please enter an explicit description of your issue
|
||||||
|
placeholder: Short and explicit description of your incident...
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: reprod
|
||||||
|
attributes:
|
||||||
|
label: "Reproduction steps"
|
||||||
|
description: Please enter an explicit description of your issue
|
||||||
|
value: |
|
||||||
|
1. Go to '...'
|
||||||
|
2. Click on '....'
|
||||||
|
3. Scroll down to '....'
|
||||||
|
4. See error
|
||||||
|
render: bash
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: screenshot
|
||||||
|
attributes:
|
||||||
|
label: "Screenshots"
|
||||||
|
description: If applicable, add screenshots to help explain your problem.
|
||||||
|
value: |
|
||||||
|

|
||||||
|
render: bash
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: textarea
|
||||||
|
id: logs
|
||||||
|
attributes:
|
||||||
|
label: "Logs"
|
||||||
|
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
|
||||||
|
render: bash
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: dropdown
|
||||||
|
id: browsers
|
||||||
|
attributes:
|
||||||
|
label: "Browsers"
|
||||||
|
description: What browsers are you seeing the problem on ?
|
||||||
|
multiple: true
|
||||||
|
options:
|
||||||
|
- Firefox
|
||||||
|
- Chrome
|
||||||
|
- Safari
|
||||||
|
- Microsoft Edge
|
||||||
|
- Opera
|
||||||
|
- Brave
|
||||||
|
- Other
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: dropdown
|
||||||
|
id: os
|
||||||
|
attributes:
|
||||||
|
label: "OS"
|
||||||
|
description: What is the impacted environment ?
|
||||||
|
multiple: true
|
||||||
|
options:
|
||||||
|
- Windows
|
||||||
|
- MacOS
|
||||||
|
- Linux
|
||||||
|
- Other
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: textarea
|
||||||
|
id: additional_information
|
||||||
|
attributes:
|
||||||
|
label: "Additional information"
|
||||||
|
description: Add any relevant information or context.
|
||||||
|
placeholder:
|
||||||
|
validations:
|
||||||
|
required: false
|
1
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
1
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
|
@ -0,0 +1 @@
|
||||||
|
blank_issues_enabled: false
|
49
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
49
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
|
@ -0,0 +1,49 @@
|
||||||
|
name: "Feature Request"
|
||||||
|
description: Brainstorm and propose new features for the project
|
||||||
|
title: "[REQUEST] - <title>"
|
||||||
|
labels: ["enhancement"]
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
*Please fill this form with as much information as possible.*
|
||||||
|
- type: textarea
|
||||||
|
id: reference_issues
|
||||||
|
attributes:
|
||||||
|
label: "Reference Issues"
|
||||||
|
description: Common issues
|
||||||
|
placeholder: "#Issues IDs"
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: textarea
|
||||||
|
id: summary
|
||||||
|
attributes:
|
||||||
|
label: "Summary"
|
||||||
|
description: Provide a brief explanation of the feature
|
||||||
|
placeholder: Describe in a few lines your feature request
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: basic_example
|
||||||
|
attributes:
|
||||||
|
label: "Basic Example"
|
||||||
|
description: Indicate here some basic examples of your feature.
|
||||||
|
placeholder: A few specific words about your feature request.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: drawbacks
|
||||||
|
attributes:
|
||||||
|
label: "Drawbacks"
|
||||||
|
description: What are the drawbacks/impacts of your feature request ?
|
||||||
|
placeholder: Identify the drawbacks and impacts while being neutral on your feature request
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: additional_information
|
||||||
|
attributes:
|
||||||
|
label: "Additional information"
|
||||||
|
description: Add any additional information that you think is important for your feature request
|
||||||
|
placeholder:
|
||||||
|
validations:
|
||||||
|
required: false
|
18
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
18
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
|
@ -0,0 +1,18 @@
|
||||||
|
## Description
|
||||||
|
|
||||||
|
- Please include a summary of the changes and the related issue.
|
||||||
|
- Fixes # (issue)
|
||||||
|
|
||||||
|
## Type of change
|
||||||
|
|
||||||
|
- [ ] New features (non-breaking change).
|
||||||
|
- [ ] Bug fix (non-breaking change).
|
||||||
|
- [ ] Breaking change (fix or feature that would cause existing functionality not to work as expected).
|
||||||
|
|
||||||
|
## Checklist
|
||||||
|
|
||||||
|
- [ ] I have performed a self-review of my code.
|
||||||
|
- [ ] I have added thorough tests if it is a core feature.
|
||||||
|
- [ ] There is a reference to the original bug report and related work.
|
||||||
|
- [ ] I have commented on my code, particularly in hard-to-understand areas.
|
||||||
|
- [ ] The feature is well documented.
|
Loading…
Reference in New Issue
Block a user