ShareX Workflow and Versioning

Scope

This file is the single source of truth for Git and versioning rules that involve:

• Commit and push workflow
• Commit message format
• Version bump behavior
• Directory.Build.props updates

This supersedes the retired docs/development/RELEASE_PROCESS.md.

Version Source Of Truth

1. Treat the root Directory.Build.props file as the app version source of truth.
2. Never set version numbers in individual .csproj files.
3. When bumping version, update every tracked Directory.Build.props in the repository so values match.
4. Derived release metadata files, such as build/windows/chocolatey/xerahs.nuspec, must be synchronized from the root version during release automation.
5. Read current version from the root Directory.Build.props first.
6. Tagged releases also generate and smoke-test the Chocolatey .nupkg, so release metadata under build/windows/chocolatey/ must stay automation-friendly.

Version Bump Policy

1. Bug fix: increment patch only (0.0.z rule: keep major/minor, increase z).
2. New feature: increment minor and reset patch.
3. Breaking change: increment major and reset minor/patch.

Required Pre-Commit Checks

Before committing and pushing:

git pull --recurse-submodules
git submodule update --init --recursive
dotnet build src/desktop/XerahS.sln

Only continue when build succeeds with 0 errors.

Commit And Push Procedure

1. Stage changes:

git add .

2. Commit using:

git commit -m "[vX.Y.Z] [Type] concise description"

3. Push:

git push

Commit Message Rules

1. Prefix every commit with the new version: [vX.Y.Z].
2. Include a type token such as [Fix], [Feature], [Build], [Docs], [Refactor].
3. Keep the description concise and specific.

Git Hook Expectations

1. Keep .githooks active (git config core.hooksPath .githooks).
2. Do not bypass hooks with --no-verify unless explicitly requested for emergency use.
3. If hooks fail, fix issues and recommit.

Documentation And Git

1. Commit Markdown documentation changes with related code/config changes.
2. Do not leave generated instruction docs uncommitted when they are part of the requested work.