Kieranties · Kieranties · May 5, 2020 · Apr 29, 2020 · Apr 30, 2020 · May 5, 2020
@@ -36,10 +36,9 @@ for guidance on writing tests.
 ### Package References
 
 To ensure dependencies are kept in sync across the projects, the `Microsoft.Build.CentralPackageVersions` SDK is used to enable versions to be
-tracked in a single location. When creating a new project, add `<Sdk Name="Microsoft.Build.CentralPackageVersions" />`
-as the first node under the `<Project>`.
+tracked in a single location.
 
-When adding a reference to a package, first add the `PackageReference` to
+When adding a reference to a _new_ package, first add the `PackageReference` to
 `Packages.props` with the specified version to be used.
 
 > Note: Use `Update` instead of include in the reference.
@@ -98,7 +97,7 @@ When writing a commit message, the message should be written in the format:
 [optional footer]
 ```
 
-The `\<type>` should be *one* of the following:
+The `<type>` should be *one* of the following:
 
 + `fix` - Resolving a bug
 + `feat` (or `feature`) - Implementing a new feature
@@ -108,16 +107,16 @@ The `\<type>` should be *one* of the following:
 + `test` - Adding tests
 + `improvement` - Improving the implementation of existing code.
 
-The `\<description>` should briefly describe the changes being addressed.
+The `<description>` should briefly describe the changes being addressed.
 
 The optional `scope` can be added to allow greater clarity on the change being
 committed, e.g.: `fix(config): Return co
 
 Additional information should be added in the optional `body`. Any issues that
-are resolved in the commit should be set flagged using `Fixes #\<issueid>`
+are resolved in the commit should be set flagged using `Fixes #<issueid>`
 
 The footer should be used to identify breaking changes.  Any commit may contain
-a breaking change.  It should be identified with `BREAKING CHANGE: \<description>`
+a breaking change.  It should be identified with `BREAKING CHANGE: <description>`
 
 #### Examples:
 ```
@@ -152,4 +151,6 @@ approver will clean things up.
 Contact
 -------
 
-If you have any queries, just ping @Kieranties
+If you have any queries, just raise a [question].
+
+[question]: https://github.com/Kieranties/SimpleVersion/issues/new/choose
@@ -1,33 +1,39 @@
 ---
 name: Bug report
 about: Raise a bug that needs fixing
-title: ''
 labels: ":bug: bug"
-assignees: ''
-
 ---
 
-**Describe the bug**
-Please provide as much info as possible.
+## Description
+<!-- Please provide as much info as possible. -->
 
-**Reproduction steps**
-Steps to reproduce the behavior (if possible provide configuration and other assets as attachment)
-1. Go to '...'
-2. Run '....'
+## Reproduction Steps
+<!--
+    Steps to reproduce the behavior (if possible provide configuration and other assets as attachment)
+    1. Go to '...'
+    2. Run '....'
+-->
 
-**Expected behavior**
-A clear and concise description of what you expected to happen.
+## Expected Behaviour
+<!-- A clear and concise description of what you expected to happen. -->
 
-**Actual Behavior**
-A clear and concise description on what you are actually seeing
+## Actual Behavior
+<!-- A clear and concise description on what you are actually seeing -->
 
+<!--
 **Screenshots**
 If applicable, add screenshots to help explain your problem.
+-->
+
 
-**Environment**
+## Environment
+<!--
  - OS: [e.g. Windows]
- - Implementation: [e.g. Commandline, Dotnet Tool, Libraries]
+ - Implementation: [e.g. Dotnet Tool, Libraries]
  - Version [e.g. 0.1.0]
+-->
 
+<!--
 **Additional context**
-Add any other context about the problem here.
+Please any additional information that you think may be useful
+-->
@@ -1,20 +1,19 @@
 ---
 name: Feature request
 about: Suggest an idea for this project
-title: ''
 labels: ":sparkles: feature"
-assignees: ''
-
 ---
 
-**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 [...]
+## Description
+<!-- 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.
+## Proposed Solution
+<!-- 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.
+## Test Cases
+<!-- Describe one or more test cases support validation of successful implementation -->
 
+<!--
 **Additional context**
-Add any other context or screenshots about the feature request here.
+Please any additional information that you think may be useful
+-->
@@ -0,0 +1,7 @@
+---
+name: Question
+about: Raise queries and get guidance
+labels: ":question: question"
+---
+
+<!-- Please describe your query in as much detail as you can! -->
@@ -1,18 +1,22 @@
 # Description
-Provide a detailed description of the changes provided in this PR
+<!-- Provide a detailed description of the changes in this PR -->
 
-Fixes # (provide one or more issues this PR fixes)
+<!--  
+    Provide one or more issues this PR fixes
+Fixes #<num>
+-->
 
 ## Change Type
-
+<!-- Please update each entry that applies with '[x]' -->
 - [ ] Documentation: Changes to docs are included
 - [ ] Infrastructure: Changes to build scripts/non-deliverables
 - [ ] Bug Fix: Fixes an issue in implementation
 - [ ] New Feature: Adds new functionality in a non-breaking manner
 - [ ] Breaking Change: Implements a fix or feature in a breaking manner
-- [ ] Other - \<please specify>
+- [ ] Other - <!-- please specify -->
 
-# Quality
+# Quality Checks
+<!-- Please update each entry that applies with '[x]' -->
 - [ ] Unit tests have been added/updated
 - [ ] Local builds/testing are successful
 - [ ] Code coverage has not decreased

@@ -7,3 +7,4 @@ integration/temp
 /docs/api/*.yml
 /docs/api/.manifest
 coverage.json
+/docs/SimpleVersion.Docs/api/
@@ -7,31 +7,33 @@
   <PropertyGroup Label="Shared Versions">
     <_xunit>2.*</_xunit>
   </PropertyGroup>
-  
+
   <ItemGroup Label="Source library packages">
-    <PackageReference Update="LibGit2Sharp"                                           Version="0.26.*" />
-    <PackageReference Update="System.Text.Json"                                       Version="4.7.*" />
+    <PackageReference Update="LibGit2Sharp" Version="0.26.*" />
+    <PackageReference Update="System.Text.Json" Version="4.7.*" />
+  </ItemGroup>
 
+  <ItemGroup Label="Docs site packages">
+    <PackageReference Update="docfx.console" Version="2.52.*" PrivateAssets="All" />
   </ItemGroup>
 
   <ItemGroup Label="Test library packages">
-    <PackageReference Update="Microsoft.NET.Test.Sdk"               Version="16.*" />
-    <PackageReference Update="xunit"                                Version="$(_xunit)" />
-    <PackageReference Update="xunit.runner.visualstudio"            Version="$(_xunit)" />
-    <PackageReference Update="FluentAssertions"                     Version="5.*" />
-    <PackageReference Update="GitTools.Testing"                     Version="1.*" />
-    <PackageReference Update="NSubstitute"                          Version="4.*" />
-    <PackageReference Update="coverlet.msbuild"                     Version="2.*" />
-    <PackageReference Update="coverlet.collector"                   Version="1.*" />
+    <PackageReference Update="Microsoft.NET.Test.Sdk" Version="16.*" />
+    <PackageReference Update="xunit" Version="$(_xunit)" />
+    <PackageReference Update="xunit.runner.visualstudio" Version="$(_xunit)" />
+    <PackageReference Update="FluentAssertions" Version="5.*" />
+    <PackageReference Update="GitTools.Testing" Version="1.*" />
+    <PackageReference Update="NSubstitute" Version="4.*" />
+    <PackageReference Update="coverlet.msbuild" Version="2.*" />
+    <PackageReference Update="coverlet.collector" Version="1.*" />
   </ItemGroup>
 
   <ItemGroup Label="Global project tooling">
     <GlobalPackageReference Include="Microsoft.CodeAnalysis.FXCopAnalyzers" Version="2.*" />
     <GlobalPackageReference Include="StyleCop.Analyzers" Version="1.*" />
   </ItemGroup>
 
-  <ItemGroup Label="Test only tooling"
-             Condition="$(MSBuildProjectName.EndsWith('Tests'))">
-    <GlobalPackageReference Include="NSubstitute.Analyzers.CSharp" Version="1.*" />    
+  <ItemGroup Label="Test only tooling" Condition="$(MSBuildProjectName.EndsWith('Tests'))">
+    <GlobalPackageReference Include="NSubstitute.Analyzers.CSharp" Version="1.*" />
   </ItemGroup>
 </Project>
@@ -1,8 +1,9 @@
 SimpleVersion
 =============
-[![Nuget](https://img.shields.io/nuget/v/SimpleVersion.Core.svg?logo=nuget)][NugetRel]
+[![Nuget](https://img.shields.io/nuget/v/SimpleVersion.Core.svg?logo=nuget&color=blue)][NugetRel]
 [![Nuget (with prereleases)](https://img.shields.io/nuget/vpre/SimpleVersion.Core.svg?logo=nuget)][NugetPre]
-[![Azure DevOps tests (branch)](https://img.shields.io/azure-devops/tests/Kieranties/SimpleVersion/1/master.svg?logo=azuredevops)][AzureRelease]
+[![Build Status](https://dev.azure.com/Kieranties/SimpleVersion/_apis/build/status/Kieranties.SimpleVersion?branchName=master)][AzureRelease]
+[![GitHub issues](https://img.shields.io/github/issues/Kieranties/Simpleversion.svg?logo=github)][Issues]
 [![License](https://img.shields.io/github/license/Kieranties/SimpleVersion.svg?logo=github)][License]
 
 SimpleVersion aims to simplify how you version the artifacts of your git repository.
@@ -15,21 +16,30 @@ Build
 -----
 
 To build SimpleVersion locally, run `build.ps1` from the root of the repository:
-```posh
-> .\build.ps1                       # => Runs a full build with unit tests
-> .\build.ps1 -BuildDocs            # => Runs a full build and creates the docs site
-> .\build.ps1 -BuildDocs -ServeDocs # Runs a full builds and serves the docs site
+```ps
+> .\build.ps1            # => Builds libraries, docs site, runs tests, prepares assets
+> .\build.ps1 -ServeDocs # => Builds libraries, docs site, then serves docs site on http://localhost:8080
 ```
 
+Issues
+------
+
+Raise and issue using one of the [templates] and it'll get automatically added to the [backlog].
+
 Contributions
 -------------
 
-Contributions, pull-requests, issues, and any other communications on the project
-are most welcome!  Please use one of the [issue templates] to get going.
+Thinking of implementing or fixing something? Great! Contributions and pull-requests are most welcome.
+
+Please take a look at the [Contributing Guide] and [Code of Conduct] before submitting your pull request.
 
-[NugetRel]:         https://www.nuget.org/packages?q=SimpleVersion&prerel=false
-[NugetPre]:         https://www.nuget.org/packages?q=SimpleVersion
-[AzureRelease]:     https://dev.azure.com/Kieranties/SimpleVersion/_build?definitionId=1
-[License]:          https://kieranties.mit-license.org/
-[Docs]:             https://simpleversion.kieranties.com
-[Issue Templates]:  https://github.com/Kieranties/SimpleVersion/issues/new/choose
+[NugetRel]:           https://www.nuget.org/packages?q=simpleversion&prerel=false
+[NugetPre]:           https://www.nuget.org/packages?q=simpleversion
+[AzureRelease]:       https://dev.azure.com/Kieranties/SimpleVersion/_build/latest?definitionId=1&branchName=master
+[License]:            https://kieranties.mit-license.org/
+[Issues]:             https://github.com/kieranties/simpleversion/issues
+[Docs]:               https://simpleversion.kieranties.com
+[templates]:          https://github.com/Kieranties/SimpleVersion/issues/new/choose
+[Contributing Guide]: https://github.com/Kieranties/SimpleVersion/blob/master/.github/CONTRIBUTING.md
+[Code of Conduct]:    https://github.com/Kieranties/SimpleVersion/blob/master/.github/CODE_OF_CONDUCT.md
+[backlog]:            https://github.com/Kieranties/SimpleVersion/projects/3
@@ -62,6 +62,10 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "ISSUE_TEMPLATE", "ISSUE_TEM
 		.github\ISSUE_TEMPLATE\information-request.md = .github\ISSUE_TEMPLATE\information-request.md
 	EndProjectSection
 EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "SimpleVersion.Docs", "docs\SimpleVersion.Docs\SimpleVersion.Docs.csproj", "{1999B6FB-2D71-4A28-B0EC-27D5F707059B}"
+EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "docs", "docs", "{24BA0F99-9FBE-4F3D-B91F-9C27202070B9}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -88,6 +92,8 @@ Global
 		{283AA9B6-B543-43C9-B512-BA54B36799B4}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{283AA9B6-B543-43C9-B512-BA54B36799B4}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{283AA9B6-B543-43C9-B512-BA54B36799B4}.Release|Any CPU.Build.0 = Release|Any CPU
+		{1999B6FB-2D71-4A28-B0EC-27D5F707059B}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{1999B6FB-2D71-4A28-B0EC-27D5F707059B}.Release|Any CPU.ActiveCfg = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -99,6 +105,7 @@ Global
 		{D95890EA-093F-4FAD-8E30-E372DD946F32} = {9EEF54AE-EEE2-4817-B0D0-AFAE3F52C231}
 		{283AA9B6-B543-43C9-B512-BA54B36799B4} = {D5992CB5-3542-41C8-BE85-F52699729C57}
 		{9FCE6A65-2C58-4615-B74F-F787706A5896} = {E4B38DC5-F211-41C6-A6F7-4589CFACF43E}
+		{1999B6FB-2D71-4A28-B0EC-27D5F707059B} = {24BA0F99-9FBE-4F3D-B91F-9C27202070B9}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {E44EF3D7-AF4C-4653-A610-5F9FE30F2FA0}

@@ -16,6 +16,7 @@
   </AdditionalDictionaryFolders>
   <IgnoredFilePatterns>
     <FilePattern>*.resx</FilePattern>
+    <FilePattern>api\*.yml</FilePattern>
   </IgnoredFilePatterns>
   <ExclusionExpressions>
     <Expression Match="https?:\/\/.+(?# Url)" Options="IgnoreCase, Singleline" />

@@ -23,13 +23,14 @@ variables:
   disable.coverage.autogenerate: true
 
 jobs:
-- job: 'Build_Assets'
+- job: 'build_test_pack'
+  displayName: "Core Build"
   pool:
     vmImage: windows-latest
   steps:
 
   # Build
-  - pwsh: ./build.ps1 -BuildDocs -ArtifactsPath $(ArtifactsPath) -Configuration $(Configuration)
+  - pwsh: ./build.ps1 -ArtifactsPath $(ArtifactsPath) -Configuration $(Configuration)
     displayName: 'Build and Test'
 
   # Publish test results
@@ -48,7 +49,7 @@ jobs:
     inputs:
       codeCoverageTool: Cobertura
       summaryFileLocation: '$(ArtifactsPath)/**/*.cobertura.xml'
-      reportDirectory: '$(ArtifactsPath)/coveragereport'
+      reportDirectory: '$(ArtifactsPath)/tests/coveragereport'
 
   # Quality check the build
   - task: BuildQualityChecks@6