Add issue and pull request template (#578)
* feat: add issue templates for bug reports, feature requests, and custom issues * feat: add pull request template for better contribution guidelines
This commit is contained in:
committed by
GitHub
parent
b06f908b2b
commit
ae1ede9310
59
.github/ISSUE_TEMPLATE/01-bug_report.yml
vendored
Normal file
59
.github/ISSUE_TEMPLATE/01-bug_report.yml
vendored
Normal file
@@ -0,0 +1,59 @@
|
||||
name: Bug Report
|
||||
description: Create a report to help us improve
|
||||
title: "[Bug]: "
|
||||
labels: ["bug"]
|
||||
assignees:
|
||||
- L4Ph
|
||||
- saicaca
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for taking the time to fill out this bug report!
|
||||
- type: textarea
|
||||
id: bug-description
|
||||
attributes:
|
||||
label: Describe the bug
|
||||
description: A clear and concise description of what the bug is.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: to-reproduce
|
||||
attributes:
|
||||
label: To Reproduce
|
||||
description: Steps to reproduce the behavior.
|
||||
placeholder: |
|
||||
1. Go to '...'
|
||||
2. Click on '....'
|
||||
3. Scroll down to '....'
|
||||
4. See error
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: expected-behavior
|
||||
attributes:
|
||||
label: Expected behavior
|
||||
description: A clear and concise description of what you expected to happen.
|
||||
validations:
|
||||
required: true
|
||||
- type: dropdown
|
||||
id: os
|
||||
attributes:
|
||||
label: OS
|
||||
multiple: true
|
||||
options:
|
||||
- Windows
|
||||
- macOS
|
||||
- Linux
|
||||
- Android
|
||||
- iOS
|
||||
- type: input
|
||||
id: browser
|
||||
attributes:
|
||||
label: Browser
|
||||
placeholder: e.g. chrome, safari
|
||||
- type: textarea
|
||||
id: additional-context
|
||||
attributes:
|
||||
label: Additional context
|
||||
description: Add any other context about the problem here.
|
||||
41
.github/ISSUE_TEMPLATE/02-feature_request.yml
vendored
Normal file
41
.github/ISSUE_TEMPLATE/02-feature_request.yml
vendored
Normal file
@@ -0,0 +1,41 @@
|
||||
name: Feature Request
|
||||
description: Suggest an idea for this project
|
||||
title: "[Feature]: "
|
||||
labels: ["enhancement"]
|
||||
assignees:
|
||||
- saicaca
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for taking the time to fill out this feature request!
|
||||
- type: textarea
|
||||
id: related-problem
|
||||
attributes:
|
||||
label: Is your feature request related to a problem?
|
||||
description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: solution
|
||||
attributes:
|
||||
label: Describe the solution you'd like
|
||||
description: A clear and concise description of what you want to happen.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: alternatives
|
||||
attributes:
|
||||
label: Describe alternatives you've considered
|
||||
description: A clear and concise description of any alternative solutions or features you've considered.
|
||||
- type: textarea
|
||||
id: additional-context
|
||||
attributes:
|
||||
label: Additional context
|
||||
description: Add any other context or screenshots about the feature request here.
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
**Disclaimer**
|
||||
|
||||
Please note that this feature request is at the discretion of the repository owner, @saicaca, and its implementation is not guaranteed.
|
||||
11
.github/ISSUE_TEMPLATE/03-custom_issue.yml
vendored
Normal file
11
.github/ISSUE_TEMPLATE/03-custom_issue.yml
vendored
Normal file
@@ -0,0 +1,11 @@
|
||||
name: Custom Issue
|
||||
description: Describe your issue here.
|
||||
title: "[Other]: "
|
||||
body:
|
||||
- type: textarea
|
||||
id: issue-description
|
||||
attributes:
|
||||
label: Issue Description
|
||||
description: Please describe your issue.
|
||||
validations:
|
||||
required: true
|
||||
37
.github/pull_request_template.md
vendored
Normal file
37
.github/pull_request_template.md
vendored
Normal file
@@ -0,0 +1,37 @@
|
||||
## Type of change
|
||||
|
||||
- [ ] Bug fix (a non-breaking change that fixes an issue)
|
||||
- [ ] New feature (a non-breaking change that adds functionality)
|
||||
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
|
||||
- [ ] Other (please describe):
|
||||
|
||||
## Checklist
|
||||
|
||||
- [ ] I have read the [**CONTRIBUTING**](https://github.com/saicaca/fuwari/blob/main/CONTRIBUTING.md) document.
|
||||
- [ ] I have checked to ensure that this Pull Request is not for personal changes.
|
||||
- [ ] I have performed a self-review of my own code.
|
||||
- [ ] My changes generate no new warnings.
|
||||
|
||||
## Related Issue
|
||||
|
||||
<!-- Please link to the issue that this pull request addresses. e.g. #123 -->
|
||||
|
||||
|
||||
## Changes
|
||||
|
||||
<!-- Please describe the changes you made in this pull request. -->
|
||||
|
||||
|
||||
## How To Test
|
||||
|
||||
<!-- Please describe how you tested your changes. -->
|
||||
|
||||
|
||||
## Screenshots (if applicable)
|
||||
|
||||
<!-- If you made any UI changes, please include screenshots. -->
|
||||
|
||||
|
||||
## Additional Notes
|
||||
|
||||
<!-- Any additional information that you want to share with the reviewer. -->
|
||||
Reference in New Issue
Block a user