Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
40 lines (27 loc) · 2.43 KB

CONTRIBUTING.md

File metadata and controls

40 lines (27 loc) · 2.43 KB
Raw

Contributing

Thanks for your interest in contributing to Rstack Editor!

Setup

  • Node.js: the version is pinned in .nvmrc (nvm use / fnm use). Node >= 22.12 is required.
  • pnpm: pinned via the packageManager field — run corepack enable pnpm once and the right version is used automatically.
pnpm install   # also installs the git hooks (rs setup)

Development

Command What it does
pnpm build Build every package
pnpm lint Lint + type check (rs lint --type-check)
pnpm fmt Format the repo (rs fmt)
pnpm test:unit Unit tests
pnpm test:e2e Full E2E chain (installs fixtures, launches a real VS Code)

To try the extension: press F5 in VS Code at the repo root — the playground launch config starts a watch build, lets you pick a fixture project, and opens an Extension Development Host on it. Run pnpm --filter rstack test:e2e:fixtures once beforehand to install the fixture dependencies.

Submitting changes

  • The pre-commit hook formats and lints staged files (rs staged).
  • CI runs build, lint, format check, unit tests and the E2E suites on Linux and Windows — please run pnpm lint && pnpm test:unit locally before pushing.
  • Keep PRs focused; fill in the PR template.

Releasing

All packages share one version and are bumped in lockstep. Today the VS Code extension (packages/vscode) is the only published artifact.

  1. On a branch, run pnpm bump (interactive; or pnpm bump --release minor) — bumpp bumps every packages/*/package.json and commits vX.Y.Z. It does not tag or push.
  2. Open a PR with that commit and merge it into main.
  3. Run the Release workflow (Actions → Release → Run workflow, branch main; gh workflow run release.yml). Tick dry run to only build the VSIX artifacts (one per platform target). A real run publishes every platform target to the VS Code Marketplace and Open VSX, then tags main as vX.Y.Z and creates the GitHub Release with notes generated from the conventional commits since the previous tag and the VSIX files attached.

Re-running a release for the same commit is safe: both marketplaces skip an already-published version and the tag step leaves a tag that already points at that commit alone. A real (non-dry) run is rejected unless dispatched from main, and fails if the version's tag already exists on a different commit — bump first.