Skip to content

Commit 335ca6a

Browse files
PlagueHOPlagueHO
authored
Merge pull request #18 from johlju/add-templates
Add pull request template and issue templates - Fixes #17
2 parents 3ee18f2 + 2da576b commit 335ca6a

5 files changed

Lines changed: 126 additions & 28 deletions

File tree

‎.github/ISSUE_TEMPLATE.md‎

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

‎.github/ISSUE_TEMPLATE/General.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
name: General question or documentation update
3+
about: If you have a general question or documentation update suggestion around the resource module.
4+
---
5+
<!--
6+
Your feedback and support is greatly appreciated, thanks for contributing!
7+
-->

‎.github/ISSUE_TEMPLATE/Problem_with_resource.md‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
---
2+
name: Problem with a resource
3+
about: If you have a problem, bug, or enhancement with a resource in this resource module.
4+
---
5+
<!--
6+
Your feedback and support is greatly appreciated, thanks for contributing!
7+
8+
ISSUE TITLE:
9+
Please prefix the issue title with the resource name, e.g.
10+
'ResourceName: Short description of my issue'
11+
12+
ISSUE DESCRIPTION (this template):
13+
Please provide information regarding your issue under each header below.
14+
Write N/A under any headers that do not apply to your issue, or if the
15+
information is not available.
16+
17+
NOTE! Sensitive information should be obfuscated.
18+
19+
PLEASE KEEP THE HEADERS.
20+
21+
You may remove this comment block, and the other comment blocks,
22+
but please keep the headers.
23+
-->
24+
#### Details of the scenario you tried and the problem that is occurring
25+
26+
#### Verbose logs showing the problem
27+
28+
#### Suggested solution to the issue
29+
30+
#### The DSC configuration that is used to reproduce the issue (as detailed as possible)
31+
```powershell
32+
# insert configuration here
33+
```
34+
35+
#### The operating system the target node is running
36+
<!--
37+
Please provide as much as possible about the target node, for example
38+
edition, version, build and language.
39+
On OS with WMF 5.1 the following command can help get this information.
40+
41+
Get-ComputerInfo -Property @(
42+
'OsName',
43+
'OsOperatingSystemSKU',
44+
'OSArchitecture',
45+
'WindowsVersion',
46+
'WindowsBuildLabEx',
47+
'OsLanguage',
48+
'OsMuiLanguages')
49+
-->
50+
51+
#### Version and build of PowerShell the target node is running
52+
<!--
53+
To help with this information, please run this command:
54+
$PSVersionTable
55+
-->
56+
57+
#### Version of the DSC module that was used ('dev' if using current dev branch)

‎.github/ISSUE_TEMPLATE/Resource_proposal.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
name: New resource proposal
3+
about: If you have a new resource proposal that you think should be added to this resource module.
4+
---
5+
<!--
6+
Thank you for contributing and making this resource module better!
7+
8+
ISSUE TITLE:
9+
Please prefix the issue title with a proposed resource name,
10+
e.g. 'NewResourceName: New resource proposal'
11+
12+
ISSUE DESCRIPTION (this template):
13+
Please propose the new resource under each header below.
14+
15+
PLEASE KEEP THE HEADERS, but you may remove this comment block.
16+
-->
17+
### Description
18+
19+
### Proposed properties
20+
21+
### Special considerations or limitations

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 41 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,47 @@
11
<!--
2-
Thanks for submitting a Pull Request (PR) to this project. Your contribution to this project is greatly appreciated!
2+
Thanks for submitting a Pull Request (PR) to this project.
3+
Your contribution to this project is greatly appreciated!
34
4-
Please prefix the PR title with the resource name, i.e. 'IniSettingsFile: My short description'
5-
If this is a breaking change, then also prefix the PR title with 'BREAKING CHANGE:', i.e. 'BREAKING CHANGE: IniSettingsFile: My short description'
5+
Please prefix the PR title with the resource name,
6+
e.g. 'ResourceName: My short description'.
7+
If this is a breaking change, then also prefix the PR title
8+
with 'BREAKING CHANGE:',
9+
e.g. 'BREAKING CHANGE: ResourceName: My short description'.
610
7-
To aid community reviewers in reviewing and merging your PR, please take the time to run through the below checklist.
8-
Change to [x] for each task in the task list that applies to this PR.
11+
You may remove this comment block, and the other comment blocks, but please
12+
keep the headers and the task list.
13+
-->
14+
#### Pull Request (PR) description
15+
<!--
16+
Replace this comment block with a description of your PR.
917
-->
10-
**Pull Request (PR) description**
11-
<!-- Replace this with a description of your pull request -->
1218

13-
**This Pull Request (PR) fixes the following issues:**
14-
<!-- Replace this with the list of issues or n/a. Use format: Fixes #123 -->
19+
#### This Pull Request (PR) fixes the following issues
20+
<!--
21+
If this PR does not fix an open issue, replace this comment block with None.
22+
If this PR resolves one or more open issues, replace this comment block with
23+
a list the issues using a GitHub closing keyword, e.g.:
24+
- Fixes #123
25+
- Fixes #124
26+
-->
1527

16-
**Task list:**
17-
- [ ] Change details added to Unreleased section of CHANGELOG.md?
18-
- [ ] Added/updated documentation, comment-based help and descriptions in .schema.mof files where appropriate?
19-
- [ ] Examples appropriately updated?
20-
- [ ] New/changed code adheres to [Style Guidelines](https://github.com/PowerShell/DscResources/blob/master/StyleGuidelines.md)?
21-
- [ ] [Unit and (optional) Integration tests](https://github.com/PowerShell/DscResources/blob/master/TestsGuidelines.md) created/updated where possible?
28+
#### Task list
29+
<!--
30+
To aid community reviewers in reviewing and merging your PR, please take
31+
the time to run through the below checklist and make sure your PR has
32+
everything updated as required.
33+
34+
Change to [x] for each task in the task list that applies to your PR.
35+
For those task that don't apply to you PR, leave those as is.
36+
-->
37+
- [ ] Added an entry under the Unreleased section of the change log in the README.md.
38+
Entry should say what was changed, and how that affects users (if applicable).
39+
- [ ] Resource documentation added/updated in README.md.
40+
- [ ] Resource parameter descriptions added/updated in README.md, schema.mof
41+
and comment-based help.
42+
- [ ] Comment-based help added/updated.
43+
- [ ] Localization strings added/updated in all localization files as appropriate.
44+
- [ ] Examples appropriately added/updated.
45+
- [ ] Unit tests added/updated. See [DSC Resource Testing Guidelines](https://github.com/PowerShell/DscResources/blob/master/TestsGuidelines.md).
46+
- [ ] Integration tests added/updated (where possible). See [DSC Resource Testing Guidelines](https://github.com/PowerShell/DscResources/blob/master/TestsGuidelines.md).
47+
- [ ] New/changed code adheres to [DSC Resource Style Guidelines](https://github.com/PowerShell/DscResources/blob/master/StyleGuidelines.md) and [Best Practices](https://github.com/PowerShell/DscResources/blob/master/BestPractices.md).

0 commit comments

Comments
 (0)