CONTRIBUTING.md

Contributing

Setup

Dependencies:

• uv
• Just (task runner)
• commit-and-tag-version (for release workflow)
• conventional-changelog
• VLC
• (Optional)Deno JS Runtime

Dev install & run

git clone https://github.com/vzhd1701/gridplayer.git
cd gridplayer
uv sync
uv run gridplayer

Local build on Windows

Install dependencies:

choco install zip innosetup

Build:

just build-win-package

Local build on MacOS

Install dependencies:

./scripts/macos/_init_local_env.sh

Build the native Apple Silicon package:

just build-macos-package-arm64

The default macOS build target is arm64. If you need an Intel build, run the same scripts from a native x86_64 Python environment with BUILD_MACOS_ARCH=x86_64.

Local build on Ubuntu

Install dependencies:

sudo apt install appstream-util

When new resources are added, the resources_bin.py needs to be updated

sudo apt install dos2unix
sudo apt install qttools5-dev-tools		# for lrelease
just generate-resources

Build:

just build-linux-appimage

Release

1. State changes in CHANGELOG.md inside ## [Unreleased] section. Use Keep a Changelog format.

As a guide, print changes from recent commits:

just changelog       # only important changes
just changelog-all   # full changelog

2. See what will be changed:

commit-and-tag-version --dry-run

3. Commit and create release tag:

commit-and-tag-version