Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
89 lines (59 loc) · 2.22 KB

CONTRIBUTING.md

File metadata and controls

89 lines (59 loc) · 2.22 KB
Raw

Packmind contribution guide

Starting the stack:

You will need node 24.18.0 and docker to start the development stack. This repo uses pnpm 11 (pinned via packageManager in package.json); enable it through corepack — no global install needed. pnpm settings (overrides, allowBuilds, hoisting) live in pnpm-workspace.yaml, not .npmrc or the package.json pnpm field, as required since pnpm 11:

nvm use
corepack enable
pnpm install --frozen-lockfile
PACKMIND_EDITION=oss node scripts/select-tsconfig.mjs
docker compose --profile=dev up

The app should be available at http://localhost:4200

Migrating an existing checkout from npm to pnpm

If you previously worked with npm, run the one-shot migration script from the repo root. It removes stale node_modules and package-lock.json, activates pnpm via corepack, installs against the lockfile, and regenerates the tsconfig:

./pnpm_migrate.sh

The script is safe to re-run.

Switching packmind-cli versions (pvm)

pvm is a lightweight dev tool (inspired by nvm) to manage multiple packmind-cli versions locally.

Source it into your shell:

source scripts/pvm.sh

To load it automatically, add this to your .zshrc or .bashrc:

[ -s "/path/to/packmind/scripts/pvm.sh" ] && . "/path/to/packmind/scripts/pvm.sh"

Then use it:

pvm ls            # list available versions from GitHub releases
pvm use 0.24.0    # switch to a version (downloads if not installed)

Versions are stored in ~/.pvm/versions/.

Releasing

Update the CHANGELOG file:

  • Update the [Unreleased] section to add the new version and release date
  • Update the [Unreleased] link at the bottom of the Changelog:
[X.Y.X]: https://github.com/PackmindHub/packmind/compare/release/<previous release number>...release/X.Y.Z

Create the relase/X.Y.Z tag and push to GitHub.

Add a new section [Unreleased] section in the Changelog:

# [Unreleased]

## Added

## Changed

## Fixed

## Removed

Add a link for the unreleased section at the bottom of the file:

[Unreleased]: https://github.com/PackmindHub/packmind/compare/release/<previous release number>...HEAD