Skip to content

Commit 408455d

Browse files
Form templates (metaplex-foundation#283)
* chore(issue-template): add bug report form * chore(issue-template): add pr template * chore(issue-template): convert pr template to markdown * chore(issue template): change file extension * refactor(form templates): add feature request issue form; make minor changes * fix(form template): fix boolean options
1 parent 7dc157b commit 408455d

File tree

3 files changed

+128
-0
lines changed

3 files changed

+128
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
name: Bug report
2+
title: "[Bug]: "
3+
description: Report incorrect or unexpected behavior
4+
labels: [bug]
5+
body:
6+
- type: dropdown
7+
id: package
8+
attributes:
9+
label: Which package is this bug report for?
10+
options:
11+
- auction-house
12+
- auction
13+
- candy-machine
14+
- core
15+
- fixed-price-sale
16+
- gumdrop
17+
- metaplex
18+
- nft-packs
19+
- token-entangler
20+
- token-metadata
21+
- token-vault
22+
validations:
23+
required: true
24+
- type: textarea
25+
id: description
26+
attributes:
27+
label: Issue description
28+
description: |
29+
Describe the issue in as much detail as possible.
30+
31+
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files into it.
32+
placeholder: |
33+
Steps to reproduce with:
34+
1. do thing
35+
2. observe behavior
36+
3. see error logs below
37+
validations:
38+
required: true
39+
- type: textarea
40+
id: logs
41+
attributes:
42+
label: Relevant log output
43+
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
44+
render: shell
45+
validations:
46+
required: false
47+
- type: dropdown
48+
id: priority
49+
attributes:
50+
label: Priority this issue should have
51+
description: Please be realistic. If you need to elaborate on your reasoning, please use the Issue description field above.
52+
options:
53+
- Low (slightly annoying)
54+
- Medium (should be fixed soon)
55+
- High (immediate attention needed)
56+
validations:
57+
required: true
Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
name: Feature request
2+
description: Request a new feature
3+
title: "[Feature]: "
4+
labels: [enhancement]
5+
body:
6+
- type: dropdown
7+
id: package
8+
attributes:
9+
label: Which package is this feature request for?
10+
options:
11+
- auction-house
12+
- auction
13+
- candy-machine
14+
- core
15+
- fixed-price-sale
16+
- gumdrop
17+
- metaplex
18+
- nft-packs
19+
- token-entangler
20+
- token-metadata
21+
- token-vault
22+
validations:
23+
required: true
24+
- type: textarea
25+
id: description
26+
attributes:
27+
label: Feature
28+
description: A clear and concise description of what the problem is, or what feature you want to be implemented.
29+
placeholder: I'm always frustrated when..., A good addition would be...
30+
validations:
31+
required: true
32+
- type: dropdown
33+
id: standard-change
34+
attributes:
35+
label: Standard Change?
36+
options:
37+
- "No"
38+
- "Yes"
39+
description: Does this feature change the Metaplex token standard in a fundamental way?
40+
validations:
41+
required: true
42+
- type: textarea
43+
id: solution
44+
attributes:
45+
label: Ideal solution or implementation
46+
description: A clear and concise description of what you want to happen.
47+
validations:
48+
required: true
49+
- type: textarea
50+
id: alternatives
51+
attributes:
52+
label: Alternative solutions or implementations
53+
description: A clear and concise description of any alternative solutions or features you have considered.
54+
- type: textarea
55+
id: additional-context
56+
attributes:
57+
label: Other context
58+
description: Any other context, screenshots, or file uploads that help us understand your feature request.
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
### Note
2+
Pull Requests that make fundamental changes to the Metaplex standard are unlikely to be accepted without a discussion first. Please open a feature request issue instead to discuss your desired changes. We are working on a more formal process for proposing changes to the Metaplex standard.
3+
4+
It's much easier for us to read and review a PR that is small, linted, and contains only one material enhancement. If your PR is very large and encompasing many features consider breaking it up in to a few PRs so we can digest the information in each pr with more accuracy.
5+
6+
### Description
7+
Describe the purpose of and changes within this Pull Request.
8+
9+
### References
10+
List links to any related tasks (GitHub Issues, Pull Requests, 3rd part task managers)
11+
12+
### Testing
13+
How was this tested? If manually tested, list all steps necessary for the reviewer to confirm.

0 commit comments

Comments
 (0)