Before you start#
For a bug, open an issue with your Hotshot version, Windows build, x64/ARM64 architecture, reproduction steps, and expected/actual behavior. Include display scaling or audio-device information when relevant.
For a substantial feature or architectural change, discuss the problem and proposed user experience in an issue before implementing it. Small fixes and documentation improvements can go straight to a pull request.
Review diagnostics and screenshots before attaching them. Remove private paths, account information, credentials, and sensitive pixels. Do not upload a whole application-data folder or private originals.
Submit a pull request#
Create a focused branch and make the smallest complete change. Update directly related user/developer documentation and include regression coverage where applicable.
Use Conventional Commits for commit subjects and the PR title:
fix: preserve local permissions when reloading shared settings
feat: add a native capture workflow
docs: clarify installation and first capture
Explain the user-visible result, why the change is needed, how you verified it, and any compatibility or hardware limitations. For UI changes, attach a safe screenshot or recording when useful.
Before requesting review, confirm that the branch builds for the affected architectures, the relevant tests pass, no secrets/private fixtures/build outputs are included, and settings/history/permission behavior is preserved. Keep unrelated refactoring and dependency upgrades in separate PRs.
The Build and test workflow builds every .NET project with strict analyzers on x64, builds the native app/MCP for x64/ARM64, checks version consistency and agent manifests, runs the x64 MCP contract and unit suites, and exercises the large-library benchmark. Native/hardware checks that cannot run in hosted CI should be described in the PR.
License and provenance#
Contributions are made under Hotshot's MIT license. Use dependencies and assets with compatible licensing and preserve required notices.
Hotshot's native workflows are independently implemented. Do not copy third-party source, binaries, or UI assets without compatible licensing and the required notices.