Merge pull request #226 from Afterlife-Guide/feature/issue-225-sonar-copilot

Add copilot instructions

Author: baynezy

.github/copilot-instructions.md

@@ -0,0 +1,65 @@
+# GitHub Copilot Instructions
+
+This document contains guidelines that GitHub Copilot should follow when assisting with this repository.
+
+## General
+
+* Make only high confidence suggestions when reviewing code changes.
+* Infer the naming conventions and coding standards from the existing codebase.
+* Prefer UK English spelling for all text, including comments and documentation.
+
+## Formatting
+
+* Apply code-formatting style defined in `.editorconfig`.
+* Prefer file-scoped namespace declarations and single-line using directives.
+* Ensure that the final return statement of a method is on its own line.
+* Use pattern matching and switch expressions wherever possible.
+* Use `nameof` instead of string literals when referring to member names.
+
+### Nullable Reference Types
+
+* Declare variables non-nullable, and check for `null` at entry points.
+* Always use `is null` or `is not null` instead of `== null` or `!= null`.
+* Trust the C# null annotations and don't add null checks when the type system says a value cannot be null.
+
+### Testing
+
+* Write unit tests for all new features and bug fixes.
+* Add `arrange`, `act`, and `assert` comments to unit tests to clarify the structure.
+* We use the following testing frameworks:
+  - xUnit for unit tests
+  - NSubstitute for mocking dependencies
+  - AwesomeAssertions for assertions
+  - Verify for snapshot testing
+  - FsCheck for Property-based testing
+* Copy existing style in nearby files for test method names and capitalisation.
+
+## Running Tests
+
+1. Install the latest version of Cake `dotnet tool install Cake.Tool`.
+2. Build using `dotnet cake --target=Build`.
+3. If that produces errors, fix those errors and build again. Repeat until the build is successful.
+4. Run tests using the Cake build script with `dotnet cake --testFilter="Category!=LocalTest"`.
+
+## SonarQube
+
+* The project name in SonarQube is `Afterlife-Guide_SemVer.Action`.
+
+## Changelog Updates
+
+For all Pull Requests created:
+
+1. **An entry must be added to CHANGELOG.md** under the `[Unreleased]` section.
+2. Entries should follow the [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) format.
+3. Group changes under the appropriate headings:
+   - `Added` for new features
+   - `Changed` for changes in existing functionality
+   - `Deprecated` for soon-to-be removed features
+   - `Removed` for now removed features
+   - `Fixed` for any bug fixes
+   - `Security` in case of vulnerabilities
+4. Be concise but descriptive in the changelog entries.
+5. Make sure the entry clearly communicates the purpose and impact of the change.
+6. Add a reference to the issue number if applicable.
+
+This changelog update is required for all PRs to maintain a comprehensive history of changes to the project.

.github/workflows/copilot-setup-steps.yml

@@ -0,0 +1,28 @@
+name: "Copilot Setup Steps"
+
+on: workflow_dispatch
+
+env:
+  GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+jobs:
+  # The job MUST be called `copilot-setup-steps` or it will not be picked up by Copilot.
+  copilot-setup-steps:
+    runs-on: ubuntu-latest
+
+    # Set the permissions to the lowest permissions possible needed for your steps.
+    # Copilot will be given its own token for its operations.
+    permissions:
+      contents: read
+
+    # You can define any steps you want, and they will run before the agent starts.
+    # If you do not check out your code, Copilot will do this for you.
+    steps:
+      - name: Checkout
+        uses: actions/checkout@08eba0b27e820071cde6df949e0beb9ba4906955
+      - name: Setup .NET Core
+        uses: actions/setup-dotnet@67a3573c9a986a3f9c594539f4ab511d57bb3ce9
+        with:
+          dotnet-version: |
+            8.0.x
+            9.0.x

CHANGELOG.md

@@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Migrated from `thomaseizinger/keep-a-changelog-new-release` to `baynezy/ChangeLogger.Action` (#210)
 - Added GH_TOKEN environment variable to all GitHub Action workflows for consistent token access (#215)
+- Set up copilot environment (#225)
 
 ## [1.1.1.16] - 2025-06-06