Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
34 lines (23 loc) · 1.56 KB

CONTRIBUTING.md

File metadata and controls

34 lines (23 loc) · 1.56 KB
Raw

Contributing

Thanks for helping make pls mode calmer and easier to trust. The beta goal is small: a friendly project cockpit that reads .plsmode.json, shows useful command buttons, and runs commands only when the user chooses to.

Local Setup

corepack enable
pnpm install --frozen-lockfile
pnpm verify

Press F5 in VS Code to launch an Extension Development Host and try the sidebar against a workspace that has a .plsmode.json.

What Makes A Good Beta PR

  • Keep changes focused and easy to review.
  • Preserve the .plsmode.json format unless a migration path is documented.
  • Treat command execution as security-sensitive.
  • Keep dangerous commands marked with danger: true and a clear confirmation message.
  • Prefer small tests around config loading, command running, and marketplace install behavior.
  • Avoid committing generated output, local reports, archives, assistant files, or VSIX packages.
  • Run pnpm verify before handing off.

Package Hygiene

The shipped VSIX should contain the compiled extension and public docs only. .vscodeignore excludes source tests, source maps, reports, campaign files, archives, local assistant files, stale generated webview output, and local VSIX files.

Before publishing the first Marketplace beta, confirm these account values:

  • publisher in package.json currently assumes plsmode.
  • repository, homepage, and bugs currently point to Christian-Katzmann/plsmode.

If the public GitHub repository or Marketplace publisher changes, update package.json, README.md, and SECURITY.md together.