Minor updates to docs (#61)

* Update docs

* Update vscode settings

* Further updates to readme

.github/PULL_REQUEST_TEMPLATE.md

@@ -12,4 +12,4 @@
   - [ ] Unit tests created/ updated
   - [ ] Rule documentation created/ updated
   - [ ] Link to a filed issue
-  - [ ] [Change log](https://github.com/Microsoft/PSRule.Rules.MSFT.OSS/blob/main/CHANGELOG.md) has been updated with change under unreleased section
+  - [ ] [Change log](https://github.com/microsoft/PSRule.Rules.MSFT.OSS/blob/main/CHANGELOG.md) has been updated with change under unreleased section

.vscode/settings.json

@@ -11,6 +11,10 @@
     },
     "editor.insertSpaces": true,
     "editor.tabSize": 4,
+    "git.branchProtection": [
+        "main",
+        "release/*"
+    ],
     "[yaml]": {
         "editor.tabSize": 2
     },
@@ -18,8 +22,7 @@
         "editor.tabSize": 2
     },
     "files.associations": {
-        "**/.azure-pipelines/*.yaml": "azure-pipelines",
-        "**/.azure-pipelines/jobs/*.yaml": "azure-pipelines"
+        "**/.azure-pipelines/**/*.yaml": "azure-pipelines"
     },
     "cSpell.words": [
     ],

README.md

@@ -3,26 +3,33 @@
 A suite of rules to validate repositories against Microsoft Open Source Software (OSS) requirements.
 This module is intended to be used by Microsoft repositories, and also serves as a functional example.
 
-![ci-badge]
+[![Open in vscode.dev](https://img.shields.io/badge/Open%20in-vscode.dev-blue)][1]
 
 ## Support
 
 This project uses GitHub Issues to track bugs and feature requests.
 Please search the existing issues before filing new issues to avoid duplicates.
 
-- For new issues, file your bug or feature request as a new [issue].
-- For help, discussion, and support questions about using this project, join or start a [discussion].
+- For new issues, file your bug or feature request as a new [issue][2].
+- For help, discussion, and support questions about using this project, join or start a [discussion][3].
 
-If you have any problems with the [PSRule][engine] engine, please check the project GitHub [issues](https://github.com/Microsoft/PSRule/issues) page instead.
+If you have any problems with the [PSRule][4] engine,
+please check the project GitHub [issues][5] page instead.
 
 Support for this project/ product is limited to the resources listed above.
 
+  [1]: https://vscode.dev/github/microsoft/PSRule.Rules.MSFT.OSS
+  [2]: https://github.com/microsoft/PSRule.Rules.MSFT.OSS/issues
+  [3]: https://github.com/microsoft/PSRule.Rules.MSFT.OSS/discussions
+  [4]: https://github.com/microsoft/PSRule
+  [5]: https://github.com/microsoft/PSRule/issues
+
 ## Getting started
 
 ### Using with GitHub Actions
 
-1. See [Creating a workflow file][create-workflow].
-2. Reference `Microsoft/ps-rule` with `modules: 'PSRule.Rules.MSFT.OSS'`
+1. See [Creating a workflow file][6].
+2. Reference `microsoft/ps-rule` with `modules: 'PSRule.Rules.MSFT.OSS'`
 3. Optionally, set option `prerelease: true` to use a pre-release version.
 
 For example:
@@ -43,27 +50,31 @@ jobs:
     steps:
 
     - name: Checkout
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
 
     # Run analysis against repository
     - name: Run PSRule analysis
-      uses: Microsoft/ps-rule@main
+      uses: microsoft/ps-rule@v2.7.0
       with:
         modules: 'PSRule.Rules.MSFT.OSS'
         prerelease: true
 ```
 
+  [6]: https://docs.github.com/actions/using-workflows#creating-a-workflow-file
+
 ## Manual install
 
 This project is designed to be run through a continuous integration (CI) pipeline using GitHub Actions.
 
-Additionally, this module can be manually installed from the [PowerShell Gallery][module].
-For manual installation see [instructions][install].
+Additionally, this module can be manually installed from the [PowerShell Gallery][7].
+For manual installation see [instructions][8].
+
+  [7]: https://www.powershellgallery.com/packages/PSRule.Rules.MSFT.OSS
+  [8]: docs/install-instructions.md
 
 ## Changes and versioning
 
-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.
+This repository uses [semantic versioning](http://semver.org/) to declare breaking changes.
 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.
@@ -88,11 +99,3 @@ or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any addi
 ## License
 
 This project is [licensed under the MIT License](LICENSE).
-
-[issue]: https://github.com/Microsoft/PSRule.Rules.MSFT.OSS/issues
-[discussion]: https://github.com/microsoft/PSRule.Rules.MSFT.OSS/discussions
-[install]: docs/install-instructions.md
-[ci-badge]: https://dev.azure.com/bewhite/PSRule.Rules.MSFT.OSS/_apis/build/status/PSRule.Rules.MSFT.OSS-CI?branchName=main
-[module]: https://www.powershellgallery.com/packages/PSRule.Rules.MSFT.OSS
-[engine]: https://github.com/Microsoft/PSRule
-[create-workflow]: https://help.github.com/en/articles/configuring-a-workflow#creating-a-workflow-file

SECURITY.md

@@ -1,22 +1,20 @@
-# Security policy
+<!-- BEGIN MICROSOFT SECURITY.MD V0.0.8 BLOCK -->
 
-<!-- BEGIN MICROSOFT SECURITY.MD V0.0.5 BLOCK -->
+# Security
 
-## Security
+Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet), [Xamarin](https://github.com/xamarin), and [our GitHub organizations](https://opensource.microsoft.com/).
 
-Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/Microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet), [Xamarin](https://github.com/xamarin), and [our GitHub organizations](https://opensource.microsoft.com/).
-
-If you believe you have found a security vulnerability in any Microsoft-owned repository that meets [Microsoft's definition of a security vulnerability](https://docs.microsoft.com/en-us/previous-versions/tn-archive/cc751383(v=technet.10)), please report it to us as described below.
+If you believe you have found a security vulnerability in any Microsoft-owned repository that meets [Microsoft's definition of a security vulnerability](https://aka.ms/opensource/security/definition), please report it to us as described below.
 
 ## Reporting Security Issues
 
 **Please do not report security vulnerabilities through public GitHub issues.**
 
-Instead, please report them to the Microsoft Security Response Center (MSRC) at [https://msrc.microsoft.com/create-report](https://msrc.microsoft.com/create-report).
+Instead, please report them to the Microsoft Security Response Center (MSRC) at [https://msrc.microsoft.com/create-report](https://aka.ms/opensource/security/create-report).
 
-If you prefer to submit without logging in, send email to [secure@microsoft.com](mailto:secure@microsoft.com).  If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://www.microsoft.com/en-us/msrc/pgp-key-msrc).
+If you prefer to submit without logging in, send email to [secure@microsoft.com](mailto:secure@microsoft.com).  If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://aka.ms/opensource/security/pgpkey).
 
-You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc). 
+You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://aka.ms/opensource/security/msrc). 
 
 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:
 
@@ -30,7 +28,7 @@ Please include the requested information listed below (as much as you can provid
 
 This information will help us triage your report more quickly.
 
-If you are reporting for a bug bounty, more complete reports can contribute to a higher bounty award. Please visit our [Microsoft Bug Bounty Program](https://microsoft.com/msrc/bounty) page for more details about our active programs.
+If you are reporting for a bug bounty, more complete reports can contribute to a higher bounty award. Please visit our [Microsoft Bug Bounty Program](https://aka.ms/opensource/security/bounty) page for more details about our active programs.
 
 ## Preferred Languages
 
@@ -38,6 +36,6 @@ We prefer all communications to be in English.
 
 ## Policy
 
-Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://www.microsoft.com/en-us/msrc/cvd).
+Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://aka.ms/opensource/security/cvd).
 
 <!-- END MICROSOFT SECURITY.MD BLOCK -->

src/PSRule.Rules.MSFT.OSS/en/MSFT.OSS.Community.md

@@ -20,4 +20,4 @@ Consider adding required files in addition to GitHub community health files.
 ## LINKS
 
 - [Releasing projects](https://docs.opensource.microsoft.com/releasing/)
-- [Creating a default community health file](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)
+- [Creating a default community health file](https://docs.github.com/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)