Updated GitHub templates (#48)
This commit is contained in:
Родитель
6ac7a9fc39
Коммит
60b4ab5fc1
|
@ -5,7 +5,7 @@ about: Report errors or unexpected behaviour
|
|||
|
||||
**Description of the issue**
|
||||
|
||||
A clear and concise description of what the bug is.
|
||||
<!-- A clear and concise description of what the bug is. -->
|
||||
|
||||
**To Reproduce**
|
||||
|
||||
|
@ -17,11 +17,11 @@ Steps to reproduce the issue:
|
|||
|
||||
**Expected behaviour**
|
||||
|
||||
A clear and concise description of what you expected to happen.
|
||||
<!-- A clear and concise description of what you expected to happen. -->
|
||||
|
||||
**Error output**
|
||||
|
||||
Capture any error messages and or verbose messages with `-Verbose`.
|
||||
<!-- Capture any error messages and or verbose messages with `-Verbose`. -->
|
||||
|
||||
```text
|
||||
|
||||
|
@ -40,4 +40,4 @@ Captured output from `$PSVersionTable`:
|
|||
|
||||
**Additional context**
|
||||
|
||||
Add any other context about the problem here.
|
||||
<!-- Add any other context about the problem here. -->
|
||||
|
|
|
@ -5,16 +5,16 @@ about: Suggest an idea
|
|||
|
||||
**Is your feature request related to a problem? Please describe.**
|
||||
|
||||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
|
||||
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
|
||||
|
||||
**Describe the solution you'd like**
|
||||
|
||||
A clear and concise description of what you want to happen.
|
||||
<!-- A clear and concise description of what you want to happen. -->
|
||||
|
||||
**Describe alternatives you've considered**
|
||||
|
||||
A clear and concise description of any alternative solutions or features you've considered.
|
||||
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
|
||||
|
||||
**Additional context**
|
||||
|
||||
Add any other context or screenshots about the feature request here.
|
||||
<!-- Add any other context or screenshots about the feature request here. -->
|
||||
|
|
|
@ -7,7 +7,7 @@ about: Suggest the creation of a new or to update an existing rule
|
|||
|
||||
## Suggested rule change
|
||||
|
||||
A clear and concise description of the what the rule should check and why.
|
||||
<!-- A clear and concise description of the what the rule should check and why. -->
|
||||
|
||||
## Applies to the following
|
||||
|
||||
|
@ -17,9 +17,11 @@ The rule applies to the following:
|
|||
|
||||
## Sample data
|
||||
|
||||
<!--
|
||||
Include a sample of passing/ failing resource JSON data.
|
||||
|
||||
> Only provide sanitized samples, replacing information such as subscription Id and names with examples (i.e. vnet-A).
|
||||
Only provide sanitized samples, replacing information such as subscription Id and names with examples (i.e. vnet-A).
|
||||
-->
|
||||
|
||||
A passing sample:
|
||||
|
||||
|
@ -35,4 +37,4 @@ A failing sample:
|
|||
|
||||
## Additional context
|
||||
|
||||
Add any other context or references.
|
||||
<!-- Add any other context or references. -->
|
||||
|
|
|
@ -1,22 +0,0 @@
|
|||
# Copyright (c) Microsoft Corporation.
|
||||
# Licensed under the MIT License.
|
||||
|
||||
# Synopsis: Check for recommended community files
|
||||
Rule 'OpenSource.Community' -Type 'PSRule.Data.RepositoryInfo' {
|
||||
$Assert.FilePath($TargetObject, 'FullName', @('CHANGELOG.md'));
|
||||
$Assert.FilePath($TargetObject, 'FullName', @('LICENSE'));
|
||||
$Assert.FilePath($TargetObject, 'FullName', @('CODE_OF_CONDUCT.md'));
|
||||
$Assert.FilePath($TargetObject, 'FullName', @('CONTRIBUTING.md'));
|
||||
$Assert.FilePath($TargetObject, 'FullName', @('SECURITY.md'));
|
||||
$Assert.FilePath($TargetObject, 'FullName', @('README.md'));
|
||||
$Assert.FilePath($TargetObject, 'FullName', @('.github/CODEOWNERS'));
|
||||
$Assert.FilePath($TargetObject, 'FullName', @('.github/PULL_REQUEST_TEMPLATE.md'));
|
||||
}
|
||||
|
||||
# Synopsis: Check for license in code files
|
||||
Rule 'OpenSource.License' -Type '.cs', '.ps1', '.psd1', '.psm1' {
|
||||
$Assert.FileHeader($TargetObject, 'FullName', @(
|
||||
'Copyright (c) Microsoft Corporation.'
|
||||
'Licensed under the MIT License.'
|
||||
));
|
||||
}
|
Загрузка…
Ссылка в новой задаче