Contributing

Questions, bug reports, and feature requests are welcome in GitHub Issues.

Propose a change

  1. Fork the repository and create a focused branch.

  2. Make the smallest change that solves the issue.

  3. Keep public API examples and configuration keys aligned with src/.

  4. Build the solution:

    dotnet restore src/MDev.Dotnet.sln
dotnet build src/MDev.Dotnet.sln --no-restore

  5. Run the unit tests:

    dotnet test src/MDev.Dotnet.sln --no-build

  6. Open a pull request describing the behavior and validation.

The solution targets .NET 10. Do not commit credentials; use configuration providers, environment variables, managed identity, or another secure secret store.

Documentation

Package documentation belongs in docs/packages/. Use relative links for repository files and link platform guidance to Microsoft Learn. Verify every command, configuration property, namespace, and method name against the current source.

Build the documentation locally with the same DocFX version used by GitHub Pages:

dotnet tool install --global docfx --version 2.78.5
docfx docs/docfx.json

Documentation home ยท Getting started

Edit this page