Skip to content

Latest commit

 

History

History
34 lines (26 loc) · 1.33 KB

CONTRIBUTING.md

File metadata and controls

34 lines (26 loc) · 1.33 KB

Contributing

Branches

  • develop — default branch, all day-to-day work.
  • production — what users install and update from. Only release merges land here.

Releasing

git checkout develop
./scripts/release.sh patch "headline" "bullet one" "bullet two"

Bumps VERSION, prepends to RELEASES.md, regenerates the site data, merges into production with a tag, pushes both branches, and creates the GitHub release. Installed copies notice within six hours (or on their next reload).

Adding a widget

See WIDGETS.md. The landing page picks new widgets up automatically — scripts/gen_site_data.sh reads the live config, and a workflow reruns it on every push to production.

Licence

sketchetc is CC BY-NC-ND 4.0. Fork it and open a pull request here as much as you like — that is welcome. What the licence rules out is distributing a modified sketchetc as a separate release, or charging anyone for it.

Config tests

scripts/test_config.sh covers the state machine: selection round trips, declared defaults, user themes beating built-ins, upgrades preserving every preference, and two static guards banning hardcoded config paths and writes into the checkout.

Enable the pre-commit hook with git config core.hooksPath .githooks. CI runs the same script, so the guard holds whether or not the hook is installed.