Add contributor and security guidelines

.github/workflows/ci.yaml

@@ -15,7 +15,12 @@ jobs:
   build-and-unit-tests:
     runs-on: ubuntu-latest
     name: Build and Unit Tests
-
+    permissions:
+      contents: write       # Required for GitHub Pages deployment
+      pages: write          # Required for GitHub Pages deployment
+      checks: write         # Required for test-reporter action
+      pull-requests: write  # Required for test-reporter action on PRs
+
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
@@ -46,20 +51,36 @@ jobs:
           path: '**/*.trx'
           reporter: dotnet-trx
 
-      - name: Upload coverage reports
-        uses: codecov/codecov-action@v4
+      - name: Install ReportGenerator
+        if: success()
+        run: dotnet tool install -g dotnet-reportgenerator-globaltool
+
+      - name: Generate Coverage HTML Report
         if: success()
+        run: |
+          reportgenerator \
+            -reports:**/coverage.cobertura.xml \
+            -targetdir:coverage-report \
+            -reporttypes:"Html;Badges" \
+            -title:"The Office API - Coverage Report"
+
+      - name: Deploy Coverage Report to GitHub Pages
+        if: success() && github.ref == 'refs/heads/main'
+        uses: peaceiris/actions-gh-pages@v3
         with:
-          files: '**/coverage.cobertura.xml'
-          fail_ci_if_error: false
-        continue-on-error: true
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./coverage-report
+          commit_message: 'docs: update coverage report'
 
   # Job 2: Mocked Integration Tests
   mocked-integration-tests:
     runs-on: ubuntu-latest
     name: Mocked Integration Tests
     needs: build-and-unit-tests
-
+    permissions:
+      checks: write         # Required for test-reporter action
+      pull-requests: write  # Required for test-reporter action on PRs
+
     steps:
       - name: Checkout code
         uses: actions/checkout@v4

README.md

@@ -1,5 +1,12 @@
 # The Office API
 
+[![CI](https://github.com/fszymaniak/TheOfficeAPI/actions/workflows/ci.yaml/badge.svg)](https://github.com/fszymaniak/TheOfficeAPI/actions/workflows/ci.yaml)
+[![CD](https://github.com/fszymaniak/TheOfficeAPI/actions/workflows/cd.yaml/badge.svg)](https://github.com/fszymaniak/TheOfficeAPI/actions/workflows/cd.yaml)
+[![Coverage Report](https://img.shields.io/badge/Coverage-Report-blue)](https://fszymaniak.github.io/TheOfficeAPI/)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=fszymaniak_TheOfficeAPI&metric=alert_status)](https://sonarcloud.io/dashboard?id=fszymaniak_TheOfficeAPI)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![.NET](https://img.shields.io/badge/.NET-9.0-512BD4)](https://dotnet.microsoft.com/download/dotnet/9.0)
+
 A REST API providing information about episodes and seasons from the TV show "The Office", designed to demonstrate the **Richardson Maturity Model** for RESTful API design.
 
 ## Overview