Update Documentation and Testing (#33)

Author: scottoffen

.github/workflows/main-publish-release.yaml

@@ -24,18 +24,14 @@ on:
     paths:
       - 'src/**'
       - '!src/**/*.md'
+      - '!src/**/*.json'
 
 jobs:
   # This job will build and run the tests for the project
   build:
     name: Build and Test
     runs-on: ubuntu-latest
 
-    # These permissions are required to restore from GitHub Packages
-    permissions:
-      contents: read
-      packages: read
-
     # The matrix strategy allows you to run the same steps on multiple operating systems
     # The library should be compatible with all the operating systems in the matrix
     strategy:
@@ -63,15 +59,6 @@ jobs:
       with:
         fetch-depth: 0
 
-    # Configure NuGet to use GitHub Packages as a source
-    - name: Configure NuGet for GitHub Packages
-      run: |
-        dotnet nuget add source https://nuget.pkg.github.com/scottoffen/index.json \
-        --name GitHub \
-        --username ${{ github.actor }} \
-        --password ${{ secrets.GITHUB_TOKEN }} \
-        --store-password-in-clear-text
-
     # Restores the dependencies for the project
     - name: Restore Dependencies
       run: dotnet restore ./src/PipeForge
@@ -124,15 +111,6 @@ jobs:
       with:
         fetch-depth: 0
 
-    # Configure NuGet to use GitHub Packages as a source
-    - name: Configure NuGet for GitHub Packages
-      run: |
-        dotnet nuget add source https://nuget.pkg.github.com/scottoffen/index.json \
-        --name GitHub \
-        --username ${{ github.actor }} \
-        --password ${{ secrets.GITHUB_TOKEN }} \
-        --store-password-in-clear-text
-
     # Restores the dependencies for the project
     - name: Restore Dependencies
       run: dotnet restore ./src/PipeForge

CONTRIBUTING.md

@@ -4,7 +4,7 @@ Community feedback is used to inform the direction of the project, and we absolu
 
 # How To Get Help
 
-A lot of issues that were created in previous versions of PipeForge were not bugs or feature requests, they were questions or discussions - most of which could be (and were) answered by anyone in the community; they're not exclusive to the maintainers. For feedback like this, there are several places where people can get all kinds of help, and we would encourage you to use them first.
+Issues are often created that are not bugs or feature requests, but rather questions or discussions - many of which could be answered by anyone in the community; they're not exclusive to the maintainers. For feedback like this, there are several places where people can get all kinds of help, and we would encourage you to use them first.
 
 - Consult the [official documentation](https://scottoffen.github.io/PipeForge).
 - Engage in our [community discussions](https://github.com/scottoffen/PipeForge/discussions).
@@ -72,4 +72,4 @@ Sometimes, your editor may completely reformat a file when you save it, making n
 
 # Documentation Changes
 
-Having excellent documentation is crucial to the success of PipeForge. Documentation for PipeForge is written using [Docusaurus](https://docusaurus.io/), lives in [docs folder](./docs/). Your contribution of clear, concise and accurate documentation is appreciated.
+Having excellent documentation is crucial to the success of PipeForge. Documentation for PipeForge is written using [Docusaurus](https://docusaurus.io/), and lives in [docs folder](./docs/). Your contribution of clear, concise and accurate documentation is appreciated.

README.md

@@ -56,7 +56,6 @@ pwsh ./test-coverage.ps1
 
 > [!NOTE]
 > This is a [Powershell](https://learn.microsoft.com/en-us/powershell/) script. You must have Powershell installed to run this command.
-> The command depends on the global installation of the dotnet tool [ReportGenerator](https://www.nuget.org/packages/ReportGenerator).
 
 ## License