Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add pull request template and issue templates (#154)
- Loading branch information
Showing
5 changed files
with
126 additions
and
29 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| --- | ||
| name: General question or documentation update | ||
| about: If you have a general question or documentation update suggestion around the resource module. | ||
| --- | ||
| <!-- | ||
| Your feedback and support is greatly appreciated, thanks for contributing! | ||
| --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| --- | ||
| name: Problem with a resource | ||
| about: If you have a problem, bug, or enhancement with a resource in this resource module. | ||
| --- | ||
| <!-- | ||
| Your feedback and support is greatly appreciated, thanks for contributing! | ||
| ISSUE TITLE: | ||
| Please prefix the issue title with the resource name, e.g. | ||
| 'ResourceName: Short description of my issue' | ||
| ISSUE DESCRIPTION (this template): | ||
| Please provide information regarding your issue under each header below. | ||
| Write N/A under any headers that do not apply to your issue, or if the | ||
| information is not available. | ||
| NOTE! Sensitive information should be obfuscated. | ||
| PLEASE KEEP THE HEADERS. | ||
| You may remove this comment block, and the other comment blocks, | ||
| but please keep the headers. | ||
| --> | ||
| #### Details of the scenario you tried and the problem that is occurring | ||
|
|
||
| #### Verbose logs showing the problem | ||
|
|
||
| #### Suggested solution to the issue | ||
|
|
||
| #### The DSC configuration that is used to reproduce the issue (as detailed as possible) | ||
| ```powershell | ||
| # insert configuration here | ||
| ``` | ||
|
|
||
| #### The operating system the target node is running | ||
| <!-- | ||
| Please provide as much as possible about the target node, for example | ||
| edition, version, build and language. | ||
| On OS with WMF 5.1 the following command can help get this information. | ||
| Get-ComputerInfo -Property @( | ||
| 'OsName', | ||
| 'OsOperatingSystemSKU', | ||
| 'OSArchitecture', | ||
| 'WindowsVersion', | ||
| 'WindowsBuildLabEx', | ||
| 'OsLanguage', | ||
| 'OsMuiLanguages') | ||
| --> | ||
|
|
||
| #### Version and build of PowerShell the target node is running | ||
| <!-- | ||
| To help with this information, please run this command: | ||
| $PSVersionTable | ||
| --> | ||
|
|
||
| #### Version of the DSC module that was used ('dev' if using current dev branch) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| --- | ||
| name: New resource proposal | ||
| about: If you have a new resource proposal that you think should be added to this resource module. | ||
| --- | ||
| <!-- | ||
| Thank you for contributing and making this resource module better! | ||
| ISSUE TITLE: | ||
| Please prefix the issue title with a proposed resource name, | ||
| e.g. 'NewResourceName: New resource proposal' | ||
| ISSUE DESCRIPTION (this template): | ||
| Please propose the new resource under each header below. | ||
| PLEASE KEEP THE HEADERS, but you may remove this comment block. | ||
| --> | ||
| ### Description | ||
|
|
||
| ### Proposed properties | ||
|
|
||
| ### Special considerations or limitations |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,21 +1,47 @@ | ||
| <!-- | ||
| Thanks for submitting a Pull Request (PR) to this project. Your contribution to this project is greatly appreciated! | ||
| Thanks for submitting a Pull Request (PR) to this project. | ||
| Your contribution to this project is greatly appreciated! | ||
| Please prefix the PR title with the resource name, i.e. 'xVMSwitch - My short description' | ||
| If this is a breaking change, then also prefix the PR title with 'BREAKING CHANGE:', i.e. 'BREAKING CHANGE: xVMSwitch - My short description' | ||
| Please prefix the PR title with the resource name, | ||
| e.g. 'ResourceName: My short description'. | ||
| If this is a breaking change, then also prefix the PR title | ||
| with 'BREAKING CHANGE:', | ||
| e.g. 'BREAKING CHANGE: ResourceName: My short description'. | ||
| To aid community reviewers in reviewing and merging your PR, please take the time to run through the below checklist. | ||
| Change to [x] for each task in the task list that applies to this PR. | ||
| You may remove this comment block, and the other comment blocks, but please | ||
| keep the headers and the task list. | ||
| --> | ||
| #### Pull Request (PR) description | ||
| <!-- | ||
| Replace this comment block with a description of your PR. | ||
| --> | ||
| **Pull Request (PR) description** | ||
| <!-- Replace this with a description of your pull request --> | ||
|
|
||
| **This Pull Request (PR) fixes the following issues:** | ||
| <!-- Replace this with the list of issues or n/a. Use format: Fixes #123 --> | ||
| #### This Pull Request (PR) fixes the following issues | ||
| <!-- | ||
| If this PR does not fix an open issue, replace this comment block with None. | ||
| If this PR resolves one or more open issues, replace this comment block with | ||
| a list the issues using a GitHub closing keyword, e.g.: | ||
| - Fixes #123 | ||
| - Fixes #124 | ||
| --> | ||
|
|
||
| **Task list:** | ||
| - [ ] Change details added to Unreleased section of CHANGELOG.md? | ||
| - [ ] Added/updated documentation, comment-based help and descriptions in .schema.mof files where appropriate? | ||
| - [ ] Examples appropriately updated / added? | ||
| - [ ] New/changed code adheres to [Style Guidelines](https://github.com/PowerShell/DscResources/blob/master/StyleGuidelines.md)? | ||
| - [ ] [Unit and (optional) Integration tests](https://github.com/PowerShell/DscResources/blob/master/TestsGuidelines.md) created/updated where possible? | ||
| #### Task list | ||
| <!-- | ||
| To aid community reviewers in reviewing and merging your PR, please take | ||
| the time to run through the below checklist and make sure your PR has | ||
| everything updated as required. | ||
| Change to [x] for each task in the task list that applies to your PR. | ||
| For those task that don't apply to you PR, leave those as is. | ||
| --> | ||
| - [ ] Added an entry under the Unreleased section of the change log in the CHANGELOG.md. | ||
| Entry should say what was changed, and how that affects users (if applicable). | ||
| - [ ] Resource documentation added/updated in README.md. | ||
| - [ ] Resource parameter descriptions added/updated in README.md, schema.mof | ||
| and comment-based help. | ||
| - [ ] Comment-based help added/updated. | ||
| - [ ] Localization strings added/updated in all localization files as appropriate. | ||
| - [ ] Examples appropriately added/updated. | ||
| - [ ] Unit tests added/updated. See [DSC Resource Testing Guidelines](https://github.com/PowerShell/DscResources/blob/master/TestsGuidelines.md). | ||
| - [ ] Integration tests added/updated (where possible). See [DSC Resource Testing Guidelines](https://github.com/PowerShell/DscResources/blob/master/TestsGuidelines.md). | ||
| - [ ] 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). |