-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
87ccac1
commit 73bb393
Showing
14 changed files
with
332 additions
and
30 deletions.
There are no files selected for viewing
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,39 @@ | ||
| name: New command proposal | ||
| description: If you have a proposal for a new public command that you think should be added to this module. The new command that is proposed shall be able to be used by a new or existing resource. | ||
| title: "NewCommandName: New command proposal" | ||
| labels: [] | ||
| assignees: [] | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Please replace `NewCommandName` in the issue title (above) with your proposed command name. | ||
| Thank you for contributing and making this module better! | ||
| - type: textarea | ||
| id: description | ||
| attributes: | ||
| label: Command proposal | ||
| description: Provide information how this command will/should work and how it will help users. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: proposedParameters | ||
| attributes: | ||
| label: Proposed parameters | ||
| description: | | ||
| List all the proposed parameters and any parameter sets that the command should have. For each parameter 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. | ||
| value: | | ||
| Parameter | Mandatory | Data type | Description | Default value | Allowed values | ||
| --- | --- | --- | --- | --- | --- | ||
| ParameterName | Yes | String | Detailed description | None | None | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: considerations | ||
| attributes: | ||
| label: Special considerations or limitations | ||
| description: | | ||
| Provide any considerations or limitations you can think of that a contributor should take in account when coding the proposed command, and or what limitations a user will encounter or should consider when using the proposed command. | ||
| validations: | ||
| required: true |
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,101 @@ | ||
| name: Problem with the module | ||
| description: If you have a problem using this module, want to report a bug, or suggest an enhancement to this module. | ||
| labels: [] | ||
| assignees: [] | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| TITLE: Please be descriptive not sensationalist. | ||
| Your feedback and support is greatly appreciated, thanks for contributing! | ||
| Please provide information regarding your issue under each section below. | ||
| **Write N/A in sections that do not apply, or if the information is not available.** | ||
| - type: textarea | ||
| id: description | ||
| attributes: | ||
| label: Problem description | ||
| description: Details of the scenario you tried and the problem that is occurring, or the enhancement you are suggesting. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: logs | ||
| attributes: | ||
| label: Verbose logs | ||
| description: | | ||
| Verbose logs showing the problem. **NOTE! Sensitive information should be obfuscated.** _Will be automatically formatted as plain text._ | ||
| placeholder: | | ||
| Paste verbose logs here | ||
| render: text | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: reproducible | ||
| attributes: | ||
| label: How to reproduce | ||
| description: Provide the steps to reproduce the problem. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: expectedBehavior | ||
| attributes: | ||
| label: Expected behavior | ||
| description: Describe what you expected to happen. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: currentBehavior | ||
| attributes: | ||
| label: Current behavior | ||
| description: Describe what actually happens. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: suggestedSolution | ||
| attributes: | ||
| label: Suggested solution | ||
| description: Do you have any suggestions how to solve the issue? | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: targetNodeOS | ||
| attributes: | ||
| label: Operating system the target node is running | ||
| description: | | ||
| Please provide as much as possible about the node running DscResource.AnalyzerRules. _Will be automatically formatted as plain text._ | ||
| To help with this information: | ||
| - On a Linux distribution, please provide the distribution name, version, and release. The following command can help get this information: `cat /etc/*-release && cat /proc/version` | ||
| - On a Windows OS please provide edition, version, build, and language. The following command can help get this information: `Get-ComputerInfo -Property @('OsName','OsOperatingSystemSKU','OSArchitecture','WindowsVersion','WindowsBuildLabEx','OsLanguage','OsMuiLanguages')` | ||
| placeholder: | | ||
| Add operating system information here | ||
| render: text | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: targetNodePS | ||
| attributes: | ||
| label: PowerShell version and build the target node is running | ||
| description: | | ||
| Please provide the version and build of PowerShell the target node is running. _Will be automatically formatted as plain text._ | ||
| To help with this information, please run this command: `$PSVersionTable` | ||
| placeholder: | | ||
| Add PowerShell information here | ||
| render: text | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: moduleVersion | ||
| attributes: | ||
| label: Module version used | ||
| description: | | ||
| Please provide the version of the DscResource.AnalyzerRules module that was used. _Will be automatically formatted as plain text._ | ||
| To help with this information, please run this command: `Get-Module -Name 'DscResource.AnalyzerRules' -ListAvailable | ft Name,Version,Path` | ||
| placeholder: | | ||
| Add module information here | ||
| render: text | ||
| validations: | ||
| required: true |
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,5 @@ | ||
| blank_issues_enabled: false | ||
| contact_links: | ||
| - name: "Virtual PowerShell User Group #DSC channel" | ||
| url: https://dsccommunity.org/community/contact/ | ||
| about: "To talk to the community and maintainers of DSC Community, please visit the #DSC channel." |
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,46 @@ | ||
| <!-- | ||
| Thanks for submitting a Pull Request (PR) to this project. | ||
| Your contribution to this project is greatly appreciated! | ||
| Please make sure the PR title is short but a descriptive | ||
| summary of the PR, | ||
| e.g "String arrays where not allowed if it had un unsupported value map". | ||
| 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. | ||
| --> | ||
|
|
||
| #### This Pull Request (PR) fixes the following issues | ||
| <!-- | ||
| Replace this comment block with the list of issues or n/a. | ||
| Use format: | ||
| - Fixes #123 | ||
| - Fixes #124 | ||
| --> | ||
|
|
||
| #### 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 pull | ||
| request (PR). For those task that don't apply to you pull request (PR), | ||
| leave those as is. | ||
| --> | ||
| - [ ] Added an entry to the change log under the Unreleased section of the | ||
| file CHANGELOG.md. Entry should say what was changed and how that | ||
| affects users (if applicable), and reference the issue being resolved | ||
| (if applicable). | ||
| - [ ] Documentation added/updated in README.md. | ||
| - [ ] Comment-based help added/updated for all new/changed functions. | ||
| - [ ] Localization strings added/updated in all localization files as appropriate. | ||
| - [ ] Examples appropriately added/updated. | ||
| - [ ] Unit tests added/updated. See [DSC Community Testing Guidelines](https://dsccommunity.org/guidelines/testing-guidelines). | ||
| - [ ] Integration tests added/updated (where possible). See | ||
| [DSC Community Testing Guidelines](https://dsccommunity.org/guidelines/testing-guidelines). | ||
| - [ ] New/changed code adheres to [DSC Community Style Guidelines](https://dsccommunity.org/styleguidelines). |
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
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,21 @@ | ||
| MIT License | ||
|
|
||
| Copyright (c) DSC Community contributors. | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. |
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
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
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,36 @@ | ||
| ## Security | ||
|
|
||
| The DSC Community takes the security of our modules seriously, which includes all | ||
| source code repositories managed through our GitHub organization. | ||
|
|
||
| If you believe you have found a security vulnerability in DscResource.AnalyzerRules, please | ||
| report it to us as described below. | ||
|
|
||
| ## Reporting Security Issues | ||
|
|
||
| **Please do not report security vulnerabilities through public GitHub issues.** | ||
|
|
||
| Instead, please create a [security advisory](https://github.com/dsccommunity/DscResource.AnalyzerRules/security/advisories). | ||
| Then please make one or several members of the DSC Community organization aware | ||
| that you created a security advisory. The easiest way to do so is to send us a | ||
| direct message via twitter or slack. | ||
|
|
||
| You should receive a response within 48 hours. If for some reason you do not, | ||
| please follow up to other member of the community. | ||
|
|
||
| Please include the requested information listed below (as much as you can provide) | ||
| to help us better understand the nature and scope of the possible issue: | ||
|
|
||
| - Type of issue | ||
| - Full paths of source file(s) related to the manifestation of the issue | ||
| - The location of the affected source code (tag/branch/commit or direct URL) | ||
| - Any special configuration required to reproduce the issue | ||
| - Step-by-step instructions to reproduce the issue | ||
| - Proof-of-concept or exploit code (if possible) | ||
| - Impact of the issue, including how an attacker might exploit the issue | ||
|
|
||
| This information will help us triage your report more quickly. | ||
|
|
||
| ## Preferred Languages | ||
|
|
||
| We prefer all communications to be in English. |
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
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
Oops, something went wrong.