mirror of
https://github.com/placeholder-soft/asdf-plugins.git
synced 2026-04-23 19:40:18 +08:00
chore: use issue forms (#443)
This commit is contained in:
47
.github/ISSUE_TEMPLATE/bug_report.md
vendored
47
.github/ISSUE_TEMPLATE/bug_report.md
vendored
@@ -1,47 +0,0 @@
|
||||
---
|
||||
name: Bug report
|
||||
about: Create a report to help us improve
|
||||
title: ''
|
||||
labels: ''
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
**Describe the bug**
|
||||
|
||||
A clear and concise description of what the bug is.
|
||||
|
||||
**To Reproduce**
|
||||
|
||||
Tell us what actions you performed before the issue occurred
|
||||
|
||||
Steps to reproduce the behavior:
|
||||
1. Go to '...'
|
||||
2. Click on '....'
|
||||
3. Scroll down to '....'
|
||||
4. See error
|
||||
|
||||
|
||||
**Expected behavior**
|
||||
|
||||
Tell us what should have happened
|
||||
|
||||
**Actual behavior**
|
||||
|
||||
Tell us what happened instead
|
||||
|
||||
### Environment
|
||||
|
||||
**OS**:
|
||||
|
||||
**asdf version**:
|
||||
|
||||
**asdf plugins affected (if relevant)**:
|
||||
|
||||
**asdf plugins installed**:
|
||||
|
||||
**Screenshots**
|
||||
If applicable, add screenshots to help explain your problem.
|
||||
|
||||
**Additional context**
|
||||
Add any other context about the problem here.
|
||||
49
.github/ISSUE_TEMPLATE/bug_report.yaml
vendored
Normal file
49
.github/ISSUE_TEMPLATE/bug_report.yaml
vendored
Normal file
@@ -0,0 +1,49 @@
|
||||
name: Bug Report
|
||||
description: Create a report to help us improve
|
||||
labels: [bug]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for taking the time to fill out this bug report!
|
||||
- type: textarea
|
||||
id: description
|
||||
attributes:
|
||||
label: Describe the Bug
|
||||
description: A clear and concise description of what the bug is.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: reproduction
|
||||
attributes:
|
||||
label: Steps to Reproduce
|
||||
description: Tell us what actions you performed before the issue occurred
|
||||
placeholder: |
|
||||
1. Go to '...'
|
||||
2. Click on '....'
|
||||
3. Scroll down to '....'
|
||||
4. See error
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: expected
|
||||
attributes:
|
||||
label: Expected Behaviour
|
||||
description: Tell us what should have happened?
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: actual
|
||||
attributes:
|
||||
label: Actual Behaviour
|
||||
description: Tell us what happened instead
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: environment
|
||||
attributes:
|
||||
label: Environment
|
||||
description: Copy the output of `asdf-info` here
|
||||
render: shell
|
||||
validations:
|
||||
required: true
|
||||
23
.github/ISSUE_TEMPLATE/feature_request.md
vendored
23
.github/ISSUE_TEMPLATE/feature_request.md
vendored
@@ -1,23 +0,0 @@
|
||||
---
|
||||
name: Feature request
|
||||
about: Suggest an idea for this project
|
||||
title: ''
|
||||
labels: ''
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
**Is your feature request related to a problem? Please describe.**
|
||||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
|
||||
|
||||
**Describe the solution you'd like**
|
||||
A clear and concise description of what you want to happen.
|
||||
|
||||
**Describe similar asdf features and why they are not sufficient**
|
||||
Describe asdf features you tried to use to accomplish what you wanted. Explain why they are insufficient for the task you were trying to accomplish.
|
||||
|
||||
**Describe workarounds you've considered**
|
||||
A clear and concise description of any alternative solutions or features you've considered.
|
||||
|
||||
**Additional context**
|
||||
Add any other context or screenshots about the feature request here.
|
||||
38
.github/ISSUE_TEMPLATE/feature_request.yaml
vendored
Normal file
38
.github/ISSUE_TEMPLATE/feature_request.yaml
vendored
Normal file
@@ -0,0 +1,38 @@
|
||||
name: Feature Request
|
||||
description: Suggest an idea for this project
|
||||
labels: []
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for taking the time to write your suggestion!
|
||||
- type: textarea
|
||||
id: problem
|
||||
attributes:
|
||||
label: Is your feature request related to a problem? Please describe
|
||||
description: Please provide a clear and concise description the problem this feature would solve. The more information you can provide here, the better.
|
||||
placeholder: I'm always frustrated when...
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: solution
|
||||
attributes:
|
||||
label: Describe the proposed solution
|
||||
description: Please provide a clear and concise description of what you would like to happen.
|
||||
placeholder: I would like to see...
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: alternatives
|
||||
attributes:
|
||||
label: "Describe similar `asdf` features and why they are not sufficient"
|
||||
description: "Describe asdf features you tried to use to accomplish what you wanted. Explain why they are insufficient for the task you were trying to accomplish."
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: workarounds
|
||||
attributes:
|
||||
label: "Describe other workarounds you've considered"
|
||||
description: "A clear and concise description of any alternative solutions or features you've considered."
|
||||
validations:
|
||||
required: true
|
||||
29
.github/PULL_REQUEST_TEMPLATE.md
vendored
29
.github/PULL_REQUEST_TEMPLATE.md
vendored
@@ -1,24 +1,15 @@
|
||||
# Checklist
|
||||
## Summary
|
||||
|
||||
- [ ] Provide a short description and link to your plugin.
|
||||
|
||||
- [ ] Make sure you CI tests for your plugin and they are green.
|
||||
|
||||
If you are using github, you might want to use the
|
||||
`plugin_test` action from [asdf-actions](https://github.com/asdf-vm/actions)
|
||||
|
||||
- [ ] `asdf-plugins` CI sanity checks are green on your PullRequest.
|
||||
|
||||
You can test locally using:
|
||||
|
||||
```bash
|
||||
./test_plugin.sh --file plugins/PLUGIN_FILE
|
||||
```
|
||||
<!-- short description of your plugin or change here -->
|
||||
|
||||
|
||||
## Other Information
|
||||
## Checklist
|
||||
|
||||
If there is anything else that is relevant to your pull request include that
|
||||
information here.
|
||||
- [ ] CI tests are green. If you are using GitHub, you might want to use the `plugin_test` action from [asdf-actions](https://github.com/asdf-vm/actions)
|
||||
- [ ] `asdf-plugins` CI sanity checks are green on your PullRequest. Test locally with:
|
||||
|
||||
Thank you for contributing to asdf-plugins!
|
||||
```bash
|
||||
./test_plugin.sh --file plugins/<PLUGIN_FILE>
|
||||
```
|
||||
|
||||
<!-- Thank you for contributing to asdf-plugins! -->
|
||||
|
||||
Reference in New Issue
Block a user