Thank you for your interest in contributing! This document outlines the process for development and releases.
We use Prettier for formatting and ESLint/Stylelint for code quality.
# Check formatting
npm run fmt:check
# Apply formatting
npm run fmt
# Run linting (Desktop)
npm run lintTo test the packaging process locally on Windows:
npm run makeThe release process is automated via GitHub Actions (release.yml).
There are two primary ways to initiate a release:
-
Pushing a Version Tag: Submit and push a new version tag (e.g.,
v1.0.1). This will trigger a full build and publish to GitHub Releases.git tag v1.0.1 git push origin v1.0.1
-
Manual Trigger (Workflow Dispatch): You can manually trigger the "Release" workflow from the GitHub Actions tab or via the GitHub CLI:
gh workflow run release.yml
The workflow builds distributables for:
- Windows: x64 (Squirrel & ZIP)
- Linux: x64 (deb, rpm, & ZIP)
- macOS: x64 & arm64 (DMG & ZIP)