Skip to content

Commit a79b672

Browse files
chore: update templates (#14)
* chore: update templates * chore: use issue forms for bug reports
1 parent 6a48caa commit a79b672

File tree

4 files changed

+91
-59
lines changed

4 files changed

+91
-59
lines changed

.github/ISSUE_TEMPLATE/bug.yaml

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
name: 🐞 Bug
2+
description: Report bugs
3+
title: "Bug: <title>"
4+
labels: [bug, triage]
5+
6+
body:
7+
- type: checkboxes
8+
attributes:
9+
label: Is there an existing issue for this?
10+
description: Please search to see if an issue already exists for the bug you encountered.
11+
options:
12+
- label: I have searched the existing issues
13+
required: true
14+
- type: input
15+
attributes:
16+
label: What version of the module are you facing this issue on?
17+
validations:
18+
required: true
19+
- type: input
20+
attributes:
21+
label: Please specify the Nuxt.js version
22+
validations:
23+
required: true
24+
- type: input
25+
attributes:
26+
label: A link (CodeSandbox) that reproduces this error or a GitHub repository
27+
validations:
28+
required: false
29+
- type: textarea
30+
attributes:
31+
label: Current Behavior
32+
description: A concise description of what you're experiencing.
33+
validations:
34+
required: false
35+
- type: textarea
36+
attributes:
37+
label: Expected Behavior
38+
description: A concise description of what you expected to happen.
39+
validations:
40+
required: false
41+
- type: textarea
42+
attributes:
43+
label: Steps To Reproduce
44+
description: Steps to reproduce the behavior.
45+
placeholder: |
46+
1. In this environment...
47+
2. With this config...
48+
3. Run '...'
49+
4. See error...
50+
validations:
51+
required: false
52+
- type: checkboxes
53+
attributes:
54+
label: Checklist
55+
options:
56+
- label: I have tested with the latest module version and the issue still occurs
57+
required: true
58+
- label: I have searched the issue tracker and this issue hasn't been reported yet
59+
required: true

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 53 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,5 @@
11
blank_issues_enabled: false
22
contact_links:
3-
- name: Nuxt Community Discord
4-
url: https://discord.nuxtjs.org/
5-
about: Consider asking questions about the module here.
6-
# - name: Documentation
7-
# url: /README.md
8-
# about: Check our documentation before reporting issues or questions.
3+
- name: Documentation
4+
url: /README.md
5+
about: Please refer to the documentation before reporting issues or asking questions.

.github/pull_request_template.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
## Description
2+
3+
(Please include a summary of the change. Mention how and why this change is introduced.)
4+
5+
### Type of change
6+
7+
Please delete options that are not relevant.
8+
9+
- [ ] Bug fix (non-breaking change which fixes an issue)
10+
- [ ] New feature (non-breaking change which adds functionality)
11+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
12+
- [ ] This change requires a documentation update
13+
14+
### Changes in this PR
15+
16+
- Add bulleted lists of all the changes made
17+
- If you want to describe more on the changes, add that after the list
18+
- Make sure these points are concise and comprehensive
19+
20+
## Checklist before merging
21+
22+
(Add to-do for reviewers and you to track, keep the PR in draft until all to-dos are cleared)
23+
24+
- [ ] Tests
25+
- [ ] Code and Readme documentation
26+
27+
## Note to reviewers (Optional)
28+
29+
(Anything that the reviewer should keep in mind)

0 commit comments

Comments
 (0)