maksit-cluster-console/CONTRIBUTING.md

1.3 KiB

Contributing to MaksIT.ClusterConsole

Maintainer agent conventions: AGENTS.md. Repo hygiene: maksit-repo-maintenance. C# style: common/csharp + repo-root .editorconfig.

Development setup

  • .NET 10 SDK
  • Git
  • PowerShell 7+ (RepoUtils under utils/)

Build

cd src
dotnet build MaksIT.ClusterConsole.slnx

Tests

utils\Invoke-TestEngine.bat

Coverage shields in README.md are rewritten by CoverageBadges.

Release

  1. Update CHANGELOG.md and bump <Version> in src/Directory.Build.props.
  2. Commit on main, tag v{version} on HEAD (v1.2.3 or SemVer prerelease such as v0.1.0-alpha.1, v0.1.0-beta.1, v0.1.0-rc.1). GitHub marks hyphenated versions as prerelease.
  3. Run utils\Invoke-ReleasePackage.bat. GitHub assets are the portable zip (win-x64), Windows setup exe, and Flatpak.

Commit format

(type): description

Types: (feature):, (bugfix):, (refactor):, (perf):, (test):, (docs):, (build):, (ci):, (style):, (revert):, (chore):.

Lowercase description; no trailing period.

License

By contributing, you agree that your contributions are licensed under the terms in LICENSE.md (Apache 2.0).