Skip to content

Commit ef21a5d

Browse files
Issue templates enhancement.
Closes #660
1 parent 7ba8564 commit ef21a5d

File tree

3 files changed

+27
-19
lines changed

3 files changed

+27
-19
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,3 +49,19 @@ body:
4949
placeholder: Sources/Core/Transaction/CodableTransaction.swift:129 func recoverPublicKey()
5050
validations:
5151
required: true
52+
- type: textarea
53+
id: os-version
54+
attributes:
55+
label: OS version
56+
description: Please specify what platform and os version you are using?
57+
placeholder: macOS 13.0.1 (22A400)
58+
validations:
59+
required: true
60+
- type: textarea
61+
id: lib-version
62+
attributes:
63+
label: Library version
64+
description: Please specify what library version you are using?
65+
placeholder: 3.0.6 or "ef06fbfc735ab687ebf89c937a9d1ffe6d81d37f" commit.
66+
validations:
67+
required: true

.github/ISSUE_TEMPLATE/documentation-request.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,16 @@ body:
99
- type: textarea
1010
id: area
1111
attributes:
12-
label: What area of the framework would you like to have improved the documentation for?
13-
description: Please be very specific and link to the relevant page in the documentation if possible.
14-
placeholder: I would like the documentation for...
12+
label: What piece of the framework are having the lack of docs?
13+
description: Bring the link, either type, either method name that is having the lack of docs
14+
placeholder: "`Sources/Core/EthereumABI.swift:ABIElementPropertiesProtocol` or `ABIElementPropertiesProtocol`"
1515
validations:
1616
required: true
1717
- type: textarea
1818
id: reason
1919
attributes:
20-
label: Why is the current documentation for this area not sufficient?
20+
label: What bit of docs would you like to have?
2121
description: A clear and concise description of why this documentation needs to be improved.
22-
placeholder: The documentation needs to be improved because...
22+
placeholder: There's a lack of docs that covers both the intent of this type and the way how it should be used within client code.
2323
validations:
2424
required: true
Lines changed: 6 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name: Feature Request
22
description: Suggest an idea for this project
3-
labels: ['feature']
3+
labels: ['enhancement']
44
body:
55
- type: markdown
66
attributes:
@@ -9,29 +9,21 @@ body:
99
- type: textarea
1010
id: problem
1111
attributes:
12-
label: Is your feature request related to a problem?
13-
description: A clear and concise description of what the problem is.
14-
placeholder: Yes, the problem is that...
12+
label: What context is your feature request related to?
13+
description: Short context name, please do not overcomplicate neither over fractionize it.
14+
placeholder: Transaction pipeline enhancement, supported platform list extending, etc.
1515
validations:
1616
required: true
1717
- type: textarea
1818
id: solution
1919
attributes:
2020
label: What solution would you like?
2121
description: A clear and concise description of what you want to happen.
22-
placeholder: I would like that...
23-
validations:
24-
required: true
25-
- type: textarea
26-
id: alternatives
27-
attributes:
28-
label: What alternatives have you considered?
29-
description: A clear and concise description of any alternative solutions or features you've considered.
30-
placeholder: I have considered to...
22+
placeholder: I would like that your lib has a magic "give me money" button, that provides me to just to build it, be uploaded to the AppStore and to get rich.
3123
validations:
3224
required: true
3325
- type: textarea
3426
id: context
3527
attributes:
3628
label: Any additional context?
37-
description: Add any other context or screenshots about the feature request here.
29+
description: Here's the pictures of house that i'd wanted to be able to bough after i've got rich and the my future cars list as well.

0 commit comments

Comments
 (0)