Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
34 lines (23 loc) · 953 Bytes

CONTRIBUTING.md

File metadata and controls

34 lines (23 loc) · 953 Bytes
Raw

Contributing

Thanks for helping improve forjd-pi.

Development setup

npm install
npm run typecheck

To test the package set in pi without installing it globally:

pi -e /path/to/forjd-pi

To test only the Git diff sidebar extension:

pi -e ./extensions/git-diff-sidebar.ts

Pull requests

  • Keep extensions small and focused.
  • Prefer passive UI that does not interrupt the main editor unless a command explicitly asks for interaction.
  • Run npm run typecheck before opening a PR.
  • GitHub Actions runs npm ci, npm run typecheck, and npm pack --dry-run on pushes and pull requests targeting main.
  • Update the README when adding commands, configuration, package contents, or visible UI changes.

Security

Pi extensions run with the user's system permissions. Avoid hidden network calls, destructive shell commands, or filesystem writes unless they are clearly documented and user initiated.