Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
53 lines (37 loc) · 1.23 KB

CONTRIBUTING.md

File metadata and controls

53 lines (37 loc) · 1.23 KB
Raw

Contributing

Thanks for considering a contribution to PromptVault.

Development Setup

npm install
npm run dev

Before Opening A Pull Request

Run:

npm run build
npm audit

If you change packaging or Electron behavior, also run:

npm run package:dir

package:dir is an unsigned smoke build. Use npm run package:dir:production when validating production-style packaging on a machine that can extract electron-builder signing helpers.

Code Style

  • Keep changes focused and easy to review.
  • Prefer existing React, Zustand, and Electron patterns already used in the project.
  • Keep file-system operations in the Electron main process.
  • Keep renderer code behind the preload API instead of importing Node APIs directly.
  • Avoid unrelated formatting churn.

Pull Request Checklist

  • Describe the user-visible change.
  • Include reproduction steps for bug fixes.
  • Note any migration impact for existing prompt libraries.
  • Update README.md or CHANGELOG.md when behavior changes.

Reporting Issues

When reporting a bug, include:

  • Operating system.
  • Node and npm versions, if it is a development issue.
  • Steps to reproduce.
  • Expected behavior.
  • Actual behavior.
  • Any relevant terminal output.