Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
43 lines (27 loc) · 2.25 KB

CONTRIBUTING.md

File metadata and controls

43 lines (27 loc) · 2.25 KB

Contributing

Keep these in sync

  • README.md — what this package is and how it's built (image, volumes, interfaces). Technical reference for developers and AI assistants.
  • instructions.md — the user-facing instructions packed into the .s9pk and shown on the Instructions tab in StartOS, for the person running the service.
  • TODO.md — pending work on this package.

Read all three before starting any work. Any code change that affects user-visible behavior must update README.md and instructions.md in the same change; add to TODO.md when you defer work, and remove items when complete. Content rules: Writing READMEs, Writing Instructions.

Environment setup

See Environment Setup

Building

npm ci    # install dependencies
make      # build the universal .s9pk

For a complete list of build options, see Makefile.

Updating the upstream version

  1. Apply the upstream bump per UPDATING.md.
  2. Update version and releaseNotes in the file under startos/versions/, renaming it to the new version string. A new version file is only needed when the bump requires a migration, or when you want the old release notes preserved in git history — see Versions.

CI/CD

Three workflows under .github/workflows/ wrap reusable workflows in start9labs/shared-workflows:

  • build.yml — on PR, builds the .s9pk and uploads per-arch artifacts for sideload testing.
  • release.yml — on v* tag, builds per arch and publishes to the test registry.
  • tagAndRelease.yml — on push to master, tags v<version> and runs release.yml, skipping if already in production.

Promotion to beta and prod is a separate, manual step.

How to contribute

  1. Fork the repository and create a branch from master.
  2. Make your changes — including the doc updates above.
  3. Open a pull request to master.