-
Notifications
You must be signed in to change notification settings - Fork 8
V10.7.1/service update #170
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
15 commits
Select commit
Hold shift + click to select a range
df2927e
🎨 remove duplicate editorconfig section
aicia-bot 95bf7ca
💬 update contributing guide
aicia-bot 7c16cd2
⬆️ upgrade dependencies to latest versions
aicia-bot 6f0446b
🔧 consolidate test environment configuration
aicia-bot 1c7e3b9
🧹 Remove stale package refs
gimlichael 9d19cf6
🔧 switch code coverage to Microsoft.Testing infrastructure
aicia-bot ab70448
💚 simplify CI test runner configuration
aicia-bot c9e9161
📝 update contributing guide for dotnet test command
aicia-bot 4266547
📝 add artifact upload step to integration test job
gimlichael a27b3b6
⬆️ upgrade microsoft testing packages
gimlichael 85389be
📦 update package release notes for v10.7.1
aicia-bot 250f337
💬 update changelog for v10.7.1
aicia-bot f3a78dd
🧪 fix flaky change token assertions in portable file provider tests
gimlichael 1bc2062
💬 update global.json documentation in changelog
aicia-bot 01da1f4
📦 add .NET Standard 2.1 availability to Cuemon.IO release notes
aicia-bot File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,53 +1,89 @@ | ||
| # Contributing to Cuemon for .NET | ||
| When contributing to this repository, please first discuss the change you wish to make via issue, | ||
| email, or any other method with the owners of this repository before making a change. | ||
| # Contributing to Cuemon for .NET | ||
|
|
||
| Please note we have a code of conduct, please follow it in all your interactions with the project. | ||
| This repository is part of the Codebelt .NET library estate. The instructions below describe the current checkout and its CI contract. Please keep changes focused and preserve the shared Codebelt build skeleton unless a deliberate policy change is being made. | ||
|
|
||
| ## Code of Conduct | ||
| Please review our [code of conduct](CODE_OF_CONDUCT.md). | ||
| ## Before you start | ||
|
|
||
| ## Our Development Process | ||
| We use GitHub with a simple GitFlow inspired flow. | ||
| All new features and/or fixes are merged into the `main` branch by creating a Pull Request. | ||
| - Read the repository `README.md` and open an issue before starting a non-trivial feature or behavioral change. | ||
| - Use an installed .NET SDK that can build the target frameworks listed below. This repository currently targets: **net10.0, net48, net9.0, netstandard2.0, netstandard2.1**. | ||
| - The solution is `Cuemon.slnx`. Central package versions are maintained in `Directory.Packages.props`. | ||
| - The shared build behavior is in `Directory.Build.props` and `Directory.Build.targets`; repository-specific TFMs, package references and metadata remain local to this library. | ||
|
|
||
| ## Pull Requests | ||
| We actively welcome your pull requests. | ||
| ## Repository shape | ||
|
|
||
| 1. Fork the repo and create your branch from `main` | ||
| 2. If you've added code that should be tested, add tests (DO follow [Microsoft Engineering Guidelines](https://github.com/dotnet/aspnetcore/wiki/Engineering-guidelines)) | ||
| 3. Any changes or additions requires documentation in the form of documenting public members | ||
| 4. Ensure that all existing as well as new test passes | ||
| 5. Issue that pull request with a big and heartful thanks for contributing | ||
| - `src/` contains production projects. | ||
| - `test/` contains xUnit v3 test projects. | ||
| - `Cuemon.slnx` is the solution used for local development. | ||
| - `.github/workflows/ci-pipeline.yml` is the CI workflow and the authority for the test matrix. | ||
| - `testenvironments.json` declares the supported `WSL-Ubuntu` and `Docker-Ubuntu` test environments. | ||
|
|
||
| ## Issues | ||
| We use GitHub issues to track public bugs. Please ensure your description is | ||
| clear and has sufficient instructions to be able to reproduce the issue. | ||
| ## Build | ||
|
|
||
| Restore and build the solution from the repository root: | ||
|
|
||
| ```powershell | ||
| dotnet restore "Cuemon.slnx" | ||
| dotnet build "Cuemon.slnx" --configuration Release --no-restore | ||
| ``` | ||
|
|
||
| CI builds both Debug and Release configurations. A clean build should complete before opening a pull request. | ||
|
|
||
| ## Test | ||
|
|
||
| Run tests one project at a time so a failing or hanging project is attributable. This mirrors the CI matrix; it does not silently turn skipped integration tests into passing tests. | ||
|
|
||
| ```powershell | ||
| $testProjects = Get-ChildItem test -Filter *.csproj -Recurse | ||
| $testProjects = $testProjects | Where-Object { $_.BaseName -notin @('Cuemon.Data.SqlClient.Tests') } | ||
| foreach ($project in $testProjects) { | ||
| dotnet test --project $project.FullName --configuration Release --no-restore | ||
| } | ||
| ``` | ||
|
|
||
| The CI test plan currently runs **38** project(s) and excludes **1** project(s). The workflow also has an optional macOS test job. | ||
|
|
||
| ## Integration and infrastructure | ||
|
|
||
| - `WSL-Ubuntu` — WSL distribution `Ubuntu-24.04`. | ||
| - `Docker-Ubuntu` — Docker image `codebeltnet/ubuntu-testrunner:8-9-10-11`. | ||
|
|
||
| ## Coding Guidelines | ||
| * Please follow Framework Design Guidelines | ||
| * Please follow SOLID principles | ||
| * Make sure you have familiarized yourself with [Cuemon for .NET - Concept Reference](https://docs.cuemon.net/) | ||
| * Consider reading my short take on [Software craftsmanship - a journey with inspirational sources!](https://github.com/gimlichael/Must-Read-Resources) | ||
| This repository has `docker-compose.yml` with these services: `database`. | ||
|
|
||
| ## Manifesto | ||
| As aspiring Software Craftsmen we are raising the bar of professional software development by practicing it and helping others learn the craft. | ||
| Start the services before running the opt-in integration tests and remove them afterwards: | ||
|
|
||
| Through this work we have come to value: | ||
| ```powershell | ||
| docker compose up -d | ||
| docker compose down | ||
| ``` | ||
|
|
||
| * Not only working software, | ||
| but also well-crafted software | ||
| * Not only responding to change, | ||
| but also steadily adding value | ||
| * Not only individuals and interactions, | ||
| but also a community of professionals | ||
| * Not only customer collaboration, | ||
| but also productive partnerships | ||
| The normal CI test matrix excludes these integration-dependent projects: | ||
| - `Cuemon.Data.SqlClient.Tests` | ||
|
|
||
| That is, in pursuit of the items on the left we have found the items on the right to be indispensable. | ||
| ## Package and documentation | ||
|
|
||
| [Manifesto for Software Craftsmanship](https://manifesto.softwarecraftsmanship.org/) is the originator of this text. | ||
| Create packages using the same solution and Release configuration: | ||
|
|
||
| ```powershell | ||
| dotnet pack "Cuemon.slnx" --configuration Release --no-restore | ||
| ``` | ||
|
|
||
| Package-specific release notes live under `.nuget/<ProjectName>/PackageReleaseNotes.txt` and package README files live beside them. `Directory.Build.targets` imports the release notes during packing. Public API changes also require XML documentation updates; DocFX documentation is built by the repository automation. | ||
|
|
||
| ## Pull requests | ||
|
|
||
| 1. Create or join an issue before substantial work, then fork the repository and create a branch from `main`. | ||
| 2. Add or update focused tests and public API documentation where applicable. | ||
| 3. Run restore, build, and the relevant per-project tests locally. | ||
| 4. Keep the pull request small, explain the behavior change and validation performed, and wait for the CI checks to pass. | ||
|
|
||
| ## Issues | ||
|
|
||
| Include the affected project, target framework, operating system, SDK version, exact command, expected result, actual result, and a minimal reproduction. Identify whether the behavior differs between local Windows/WSL, Docker-Ubuntu and GitHub Actions. | ||
|
|
||
| ## Coding guidelines | ||
|
|
||
| Follow the existing style, the Framework Design Guidelines, the repository `.editorconfig`, and the shared Codebelt conventions. Do not make unrelated formatting or infrastructure changes in a feature pull request. | ||
|
|
||
| ## License | ||
| By contributing to Cuemon for .NET, you agree that your contributions will be licensed | ||
| under the MIT license. | ||
|
|
||
| By contributing to Cuemon for .NET, you agree that your contributions will be licensed under the MIT license. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6 changes: 6 additions & 0 deletions
6
.nuget/Cuemon.AspNetCore.Authentication/PackageReleaseNotes.txt
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6 changes: 6 additions & 0 deletions
6
.nuget/Cuemon.AspNetCore.Razor.TagHelpers/PackageReleaseNotes.txt
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6 changes: 6 additions & 0 deletions
6
.nuget/Cuemon.Extensions.AspNetCore.Authentication/PackageReleaseNotes.txt
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6 changes: 6 additions & 0 deletions
6
.nuget/Cuemon.Extensions.AspNetCore.Mvc.Formatters.Text.Json/PackageReleaseNotes.txt
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6 changes: 6 additions & 0 deletions
6
.nuget/Cuemon.Extensions.AspNetCore.Mvc.Formatters.Xml/PackageReleaseNotes.txt
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6 changes: 6 additions & 0 deletions
6
.nuget/Cuemon.Extensions.AspNetCore.Mvc.RazorPages/PackageReleaseNotes.txt
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6 changes: 6 additions & 0 deletions
6
.nuget/Cuemon.Extensions.AspNetCore.Mvc/PackageReleaseNotes.txt
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6 changes: 6 additions & 0 deletions
6
.nuget/Cuemon.Extensions.AspNetCore.Text.Json/PackageReleaseNotes.txt
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6 changes: 6 additions & 0 deletions
6
.nuget/Cuemon.Extensions.AspNetCore.Xml/PackageReleaseNotes.txt
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6 changes: 6 additions & 0 deletions
6
.nuget/Cuemon.Extensions.Collections.Generic/PackageReleaseNotes.txt
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6 changes: 6 additions & 0 deletions
6
.nuget/Cuemon.Extensions.Collections.Specialized/PackageReleaseNotes.txt
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6 changes: 6 additions & 0 deletions
6
.nuget/Cuemon.Extensions.Data.Integrity/PackageReleaseNotes.txt
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The shown loop runs only with
--configuration Release, but the text says it matches the automated checks, which also run Debug. Contributors can follow this guidance and miss a Debug-specific regression until it is caught remotely. This is a non-blocking documentation concern; either run both configurations locally or describe this as a Release-only validation pass.Artifacts
Evidence from the check
Command output from the check
Prompt To Fix With AI
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!