Skip to content

Commit d88808a

Browse files
committed
update issue template for new function
1 parent 8688b35 commit d88808a

4 files changed

Lines changed: 28 additions & 66 deletions

File tree

.github/ISSUE_TEMPLATE/Problem_with_module.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ body:
6161
- type: textarea
6262
id: targetNodeOS
6363
attributes:
64-
label: Operating system the target node is running
64+
label: Operating system you are running FabricTools on
6565
description: |
6666
Please provide as much as possible about the node running FabricTools. _Will be automatically formatted as plain text._
6767
@@ -100,4 +100,3 @@ body:
100100
render: text
101101
validations:
102102
required: true
103-
Lines changed: 8 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
name: Problem with a resource
2-
description: If you have a problem, bug, or enhancement with a resource in this resource module.
1+
name: Problem with a function
2+
description: If you have a problem, bug, or enhancement with a function in this module.
33
labels: []
44
assignees: []
55
body:
66
- type: markdown
77
attributes:
88
value: |
9-
Please prefix the issue title (above) with the resource name, e.g. 'ResourceName: Short description of my issue'!
9+
Please prefix the issue title (above) with the function name, e.g. 'FunctionName: Short description of my issue'!
1010
1111
Your feedback and support is greatly appreciated, thanks for contributing!
1212
- type: textarea
@@ -28,14 +28,14 @@ body:
2828
validations:
2929
required: true
3030
- type: textarea
31-
id: configuration
31+
id: version
3232
attributes:
33-
label: DSC configuration
33+
label: Module Version
3434
description: |
35-
The DSC configuration that is used to reproduce the issue (as detailed as possible). **NOTE! Sensitive information should be obfuscated.** _Will be automatically formatted as PowerShell code._
35+
The version of the FabricTools module you are using. _Will be automatically formatted as plain text._
36+
To help with this information, please run this command: `Get-Module -Name 'FabricTools' | ft Name,Version,Path`
3637
placeholder: |
37-
Paste DSC configuration here
38-
render: powershell
38+
Paste output here
3939
validations:
4040
required: true
4141
- type: textarea
@@ -45,43 +45,3 @@ body:
4545
description: Do you have any suggestions how to solve the issue?
4646
validations:
4747
required: true
48-
- type: textarea
49-
id: targetNodeOS
50-
attributes:
51-
label: Operating system the target node is running
52-
description: |
53-
Please provide as much as possible about the target node, for example edition, version, build, and language. _Will be automatically formatted as plain text._
54-
55-
On OS with WMF 5.1 the following command can help get this information: `Get-ComputerInfo -Property @('OsName','OsOperatingSystemSKU','OSArchitecture','WindowsVersion','WindowsBuildLabEx','OsLanguage','OsMuiLanguages')`
56-
placeholder: |
57-
Add operating system information here
58-
render: text
59-
validations:
60-
required: true
61-
- type: textarea
62-
id: targetNodePS
63-
attributes:
64-
label: PowerShell version and build the target node is running
65-
description: |
66-
Please provide the version and build of PowerShell the target node is running. _Will be automatically formatted as plain text._
67-
68-
To help with this information, please run this command: `$PSVersionTable`
69-
placeholder: |
70-
Add PowerShell information here
71-
render: text
72-
validations:
73-
required: true
74-
- type: textarea
75-
id: moduleVersion
76-
attributes:
77-
label: FabricTools version
78-
description: |
79-
Please provide the version of the FabricTools module that was used. _Will be automatically formatted as plain text._
80-
81-
To help with this information, please run this command: `Get-Module -Name 'FabricTools' -ListAvailable | ft Name,Version,Path`
82-
placeholder: |
83-
Add module information here
84-
render: text
85-
validations:
86-
required: true
87-
Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,43 @@
1-
name: New resource proposal
2-
description: If you have a new resource proposal that you think should be added to this resource module.
3-
title: "NewResourceName: New resource proposal"
1+
name: New function proposal
2+
description: If you have a new function proposal that you think should be added to this module.
3+
title: "NewFunctionName: New resource proposal"
44
labels: []
55
assignees: []
66
body:
77
- type: markdown
88
attributes:
99
value: |
10-
Please replace `NewResourceName` in the issue title (above) with your proposed resource name.
10+
Please replace `NewFunctionName` in the issue title (above) with your proposed function name.
1111
12-
Thank you for contributing and making this resource module better!
12+
Thank you for contributing and making FabricTools better!
1313
- type: textarea
1414
id: description
1515
attributes:
16-
label: Resource proposal
17-
description: Provide information how this resource will/should work and how it will help users.
16+
label: Function proposal
17+
description: Provide information how this function will/should work and how it will help users.
1818
validations:
1919
required: true
2020
- type: textarea
2121
id: proposedProperties
2222
attributes:
2323
label: Proposed properties
2424
description: |
25-
List all the proposed properties that the resource should have (key, required, write, and/or read). For each property provide a detailed description, the data type, if a default value should be used, and if the property is limited to a set of values.
25+
List all the proposed properties and parameters that the function should have.
2626
value: |
27-
Property | Type qualifier | Data type | Description | Default value | Allowed values
28-
--- | --- | --- | --- | --- | ---
29-
PropertyName | Key | String | Detailed description | None | None
27+
Parameter | Description | Data type | Default value | Allowed values
28+
--- | --- | --- | --- | ---
29+
ParameterName | Detailed description | String | None | Any
30+
31+
Property | Description
32+
--- | ---
33+
PropertyName | Detailed description
3034
validations:
3135
required: true
3236
- type: textarea
3337
id: considerations
3438
attributes:
3539
label: Special considerations or limitations
3640
description: |
37-
Provide any considerations or limitations you can think of that a contributor should take in account when coding the proposed resource, and or what limitations a user will encounter or should consider when using the proposed resource.
41+
Provide any considerations or limitations you can think of that a contributor should take in account when coding the proposed function, and or what limitations a user will encounter or should consider when using the proposed function.
3842
validations:
3943
required: true

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
blank_issues_enabled: false
22
contact_links:
3-
- name: "Virtual PowerShell User Group #DSC channel"
4-
url: https://dsccommunity.org/community/contact/
5-
about: "To talk to the community and maintainers of DSC Community, please visit the #DSC channel."
6-
3+
- name: "FabricTools Community"
4+
url: https://github.com/dataplat/FabricTools/discussions
5+
about: "To talk to the community and maintainers of FabricTools, please head to GitHub discussions."

0 commit comments

Comments
 (0)