Added standard repo files (#1)
This commit is contained in:
Родитель
2b20223ab8
Коммит
7b29a324b0
|
@ -0,0 +1,2 @@
|
||||||
|
# https://help.github.com/articles/about-codeowners/
|
||||||
|
* @microsoft/psrule-requirements
|
|
@ -0,0 +1,43 @@
|
||||||
|
---
|
||||||
|
name: Bug report
|
||||||
|
about: Report errors or unexpected behaviour
|
||||||
|
---
|
||||||
|
|
||||||
|
**Description of the issue**
|
||||||
|
|
||||||
|
A clear and concise description of what the bug is.
|
||||||
|
|
||||||
|
**To Reproduce**
|
||||||
|
|
||||||
|
Steps to reproduce the issue:
|
||||||
|
|
||||||
|
```powershell
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
**Expected behaviour**
|
||||||
|
|
||||||
|
A clear and concise description of what you expected to happen.
|
||||||
|
|
||||||
|
**Error output**
|
||||||
|
|
||||||
|
Capture any error messages and or verbose messages with `-Verbose`.
|
||||||
|
|
||||||
|
```text
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
**Module in use and version:**
|
||||||
|
|
||||||
|
- Module: PSRule.Requirements
|
||||||
|
- Version: **[e.g. 0.1.0]**
|
||||||
|
|
||||||
|
Captured output from `$PSVersionTable`:
|
||||||
|
|
||||||
|
```text
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
**Additional context**
|
||||||
|
|
||||||
|
Add any other context about the problem here.
|
|
@ -0,0 +1,20 @@
|
||||||
|
---
|
||||||
|
name: Feature request
|
||||||
|
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 [...]
|
||||||
|
|
||||||
|
**Describe the solution you'd like**
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
**Additional context**
|
||||||
|
|
||||||
|
Add any other context or screenshots about the feature request here.
|
|
@ -0,0 +1,14 @@
|
||||||
|
## PR Summary
|
||||||
|
|
||||||
|
<!-- summarize your PR between here and the checklist -->
|
||||||
|
|
||||||
|
## PR Checklist
|
||||||
|
|
||||||
|
- [ ] PR has a meaningful title
|
||||||
|
- [ ] Summarized changes
|
||||||
|
- [ ] Change is not breaking
|
||||||
|
- [ ] This PR is ready to merge and is not **Work in Progress**
|
||||||
|
- **Code changes**
|
||||||
|
- [ ] Have unit tests created/ updated
|
||||||
|
- [ ] Link to a filed issue
|
||||||
|
- [ ] [Change log](https://github.com/Microsoft/PSRule.Requirements/blob/master/CHANGELOG.md) has been updated with change under unreleased section
|
|
@ -0,0 +1,8 @@
|
||||||
|
|
||||||
|
.vs/
|
||||||
|
reports/
|
||||||
|
out/
|
||||||
|
**/bin/
|
||||||
|
**/obj/
|
||||||
|
*.user
|
||||||
|
*.diagsession
|
|
@ -0,0 +1,67 @@
|
||||||
|
{
|
||||||
|
"default": true,
|
||||||
|
"header-increment": true,
|
||||||
|
"first-header-h1": {
|
||||||
|
"level": 1
|
||||||
|
},
|
||||||
|
"header-style": {
|
||||||
|
"style": "atx"
|
||||||
|
},
|
||||||
|
"ul-style": {
|
||||||
|
"style": "dash"
|
||||||
|
},
|
||||||
|
"list-indent": true,
|
||||||
|
"ul-start-left": true,
|
||||||
|
"ul-indent": {
|
||||||
|
"indent": 2
|
||||||
|
},
|
||||||
|
"no-trailing-spaces": true,
|
||||||
|
"no-hard-tabs": true,
|
||||||
|
"no-reversed-links": true,
|
||||||
|
"no-multiple-blanks": true,
|
||||||
|
"line-length": {
|
||||||
|
"line_length": 100,
|
||||||
|
"code_blocks": false,
|
||||||
|
"tables": false,
|
||||||
|
"headers": true
|
||||||
|
},
|
||||||
|
"commands-show-output": true,
|
||||||
|
"no-missing-space-atx": true,
|
||||||
|
"no-multiple-space-atx": true,
|
||||||
|
"no-missing-space-closed-atx": true,
|
||||||
|
"no-multiple-space-closed-atx": true,
|
||||||
|
"blanks-around-headers": true,
|
||||||
|
"header-start-left": true,
|
||||||
|
"no-duplicate-header": true,
|
||||||
|
"single-h1": true,
|
||||||
|
"no-trailing-punctuation": {
|
||||||
|
"punctuation": ".,;:!"
|
||||||
|
},
|
||||||
|
"no-multiple-space-blockquote": true,
|
||||||
|
"no-blanks-blockquote": true,
|
||||||
|
"ol-prefix": {
|
||||||
|
"style": "one_or_ordered"
|
||||||
|
},
|
||||||
|
"list-marker-space": true,
|
||||||
|
"blanks-around-fences": true,
|
||||||
|
"blanks-around-lists": true,
|
||||||
|
"no-bare-urls": true,
|
||||||
|
"hr-style": {
|
||||||
|
"style": "---"
|
||||||
|
},
|
||||||
|
"no-emphasis-as-header": true,
|
||||||
|
"no-space-in-emphasis": true,
|
||||||
|
"no-space-in-code": true,
|
||||||
|
"no-space-in-links": true,
|
||||||
|
"fenced-code-language": false,
|
||||||
|
"first-line-h1": false,
|
||||||
|
"no-empty-links": true,
|
||||||
|
"proper-names": {
|
||||||
|
"names": [
|
||||||
|
"PowerShell",
|
||||||
|
"JavaScript"
|
||||||
|
],
|
||||||
|
"code_blocks": false
|
||||||
|
},
|
||||||
|
"no-alt-text": true
|
||||||
|
}
|
|
@ -0,0 +1,8 @@
|
||||||
|
{
|
||||||
|
"recommendations": [
|
||||||
|
"ms-vscode.powershell",
|
||||||
|
"ms-azure-devops.azure-pipelines",
|
||||||
|
"redhat.vscode-yaml",
|
||||||
|
"streetsidesoftware.code-spell-checker"
|
||||||
|
]
|
||||||
|
}
|
|
@ -0,0 +1,36 @@
|
||||||
|
{
|
||||||
|
"files.exclude": {
|
||||||
|
"reports/": true,
|
||||||
|
"out/": true,
|
||||||
|
".vs/": true,
|
||||||
|
"**/bin/": true,
|
||||||
|
"**/obj/": true
|
||||||
|
},
|
||||||
|
"search.exclude": {
|
||||||
|
"out/": true
|
||||||
|
},
|
||||||
|
"editor.insertSpaces": true,
|
||||||
|
"editor.tabSize": 4,
|
||||||
|
"[yaml]": {
|
||||||
|
"editor.tabSize": 2
|
||||||
|
},
|
||||||
|
"[markdown]": {
|
||||||
|
"editor.tabSize": 2
|
||||||
|
},
|
||||||
|
"files.associations": {
|
||||||
|
"**/.azure-pipelines/*.yaml": "azure-pipelines"
|
||||||
|
},
|
||||||
|
"cSpell.words": [
|
||||||
|
"hashtable"
|
||||||
|
],
|
||||||
|
"cSpell.enabledLanguageIds": [
|
||||||
|
"csharp",
|
||||||
|
"git-commit",
|
||||||
|
"markdown",
|
||||||
|
"plaintext",
|
||||||
|
"powershell",
|
||||||
|
"text",
|
||||||
|
"yaml",
|
||||||
|
"yml"
|
||||||
|
]
|
||||||
|
}
|
|
@ -0,0 +1,5 @@
|
||||||
|
# Change log
|
||||||
|
|
||||||
|
## Unreleased
|
||||||
|
|
||||||
|
- No releases yet.
|
|
@ -0,0 +1,48 @@
|
||||||
|
# Contributing
|
||||||
|
|
||||||
|
This project welcomes contributions and suggestions. Most contributions require you to
|
||||||
|
agree to a Contributor License Agreement (CLA) declaring that you have the right to,
|
||||||
|
and actually do, grant us the rights to use your contribution. For details, visit
|
||||||
|
https://cla.microsoft.com.
|
||||||
|
|
||||||
|
When you submit a pull request, a CLA-bot will automatically determine whether you need
|
||||||
|
to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the
|
||||||
|
instructions provided by the bot. You will only need to do this once across all repositories using our CLA.
|
||||||
|
|
||||||
|
## Code of Conduct
|
||||||
|
|
||||||
|
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
|
||||||
|
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
|
||||||
|
or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
|
||||||
|
|
||||||
|
## How to contribute
|
||||||
|
|
||||||
|
- File or vote up issues
|
||||||
|
- Improve documentation
|
||||||
|
- Fix bugs or add features
|
||||||
|
|
||||||
|
### Intro to Git and GitHub
|
||||||
|
|
||||||
|
When contributing to documentation or code changes, you'll need to have a GitHub account and a basic understanding of Git.
|
||||||
|
Check out the links below to get started.
|
||||||
|
|
||||||
|
- Make sure you have a [GitHub account][github-signup].
|
||||||
|
- GitHub Help:
|
||||||
|
- [Git and GitHub learning resources][learn-git].
|
||||||
|
- [GitHub Flow Guide][github-flow].
|
||||||
|
|
||||||
|
## Contributing to issues
|
||||||
|
|
||||||
|
- Check if the issue you are going to file already exists in our GitHub [issues](https://github.com/Microsoft/PSRule.Requirements/issues).
|
||||||
|
- If you do not see your problem captured, please file a new issue and follow the provided template.
|
||||||
|
- If the an open issue exists for the problem you are experiencing, vote up the issue or add a comment.
|
||||||
|
|
||||||
|
## Contributing to code
|
||||||
|
|
||||||
|
- Before writing a fix or feature enhancement, ensure that an issue is logged.
|
||||||
|
- Be prepared to discuss a feature and take feedback.
|
||||||
|
- Include unit tests and updates documentation to complement the change.
|
||||||
|
|
||||||
|
[learn-git]: https://help.github.com/en/articles/git-and-github-learning-resources
|
||||||
|
[github-flow]: https://guides.github.com/introduction/flow/
|
||||||
|
[github-signup]: https://github.com/signup/free
|
34
LICENSE
34
LICENSE
|
@ -1,21 +1,21 @@
|
||||||
MIT License
|
MIT License
|
||||||
|
|
||||||
Copyright (c) Microsoft Corporation.
|
Copyright (c) Microsoft Corporation.
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
in the Software without restriction, including without limitation the rights
|
in the Software without restriction, including without limitation the rights
|
||||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
copies of the Software, and to permit persons to whom the Software is
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
furnished to do so, subject to the following conditions:
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be included in all
|
The above copyright notice and this permission notice shall be included in all
|
||||||
copies or substantial portions of the Software.
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
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
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
SOFTWARE
|
SOFTWARE.
|
||||||
|
|
43
README.md
43
README.md
|
@ -1,14 +1,39 @@
|
||||||
|
# PSRule.Requirements
|
||||||
|
|
||||||
# Contributing
|
Integration between [PSRule] and [Requirements].
|
||||||
|
|
||||||
This project welcomes contributions and suggestions. Most contributions require you to agree to a
|
**This project is still in the early stages.**
|
||||||
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
|
|
||||||
the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
|
|
||||||
|
|
||||||
When you submit a pull request, a CLA bot will automatically determine whether you need to provide
|
## Changes and versioning
|
||||||
a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
|
|
||||||
provided by the bot. You will only need to do this once across all repos using our CLA.
|
Modules in this repository will use the [semantic versioning](http://semver.org/) model to declare breaking changes from v1.0.0.
|
||||||
|
Prior to v1.0.0, breaking changes may be introduced in minor (0.x.0) version increments.
|
||||||
|
For a list of module changes please see the [change log](CHANGELOG.md).
|
||||||
|
|
||||||
|
> Pre-release module versions are created on major commits and can be installed from the PowerShell Gallery.
|
||||||
|
> Pre-release versions should be considered experimental.
|
||||||
|
> Modules and change log details for pre-releases will be removed as standard releases are made available.
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
This project welcomes contributions and suggestions.
|
||||||
|
If you are ready to contribute, please visit the [contribution guide](CONTRIBUTING.md).
|
||||||
|
|
||||||
|
## Code of Conduct
|
||||||
|
|
||||||
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
|
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
|
||||||
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
|
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
|
||||||
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
|
or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
|
||||||
|
|
||||||
|
## Maintainers
|
||||||
|
|
||||||
|
- [Bernie White](https://github.com/BernieWhite)
|
||||||
|
- [Chris Kuech](https://github.com/chriskuech)
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
This project is [licensed under the MIT License](LICENSE).
|
||||||
|
|
||||||
|
[ci-badge]: https://dev.azure.com/bewhite/PSRule.Requirements/_apis/build/status/PSRule.Requirements-CI?branchName=master
|
||||||
|
[PSRule]: https://github.com/Microsoft/PSRule
|
||||||
|
[Requirements]: https://github.com/Microsoft/Requirements
|
||||||
|
|
|
@ -1,3 +1,5 @@
|
||||||
|
# Security policy
|
||||||
|
|
||||||
<!-- BEGIN MICROSOFT SECURITY.MD V0.0.3 BLOCK -->
|
<!-- BEGIN MICROSOFT SECURITY.MD V0.0.3 BLOCK -->
|
||||||
|
|
||||||
## Security
|
## Security
|
||||||
|
|
Загрузка…
Ссылка в новой задаче