Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
48 lines (34 loc) · 1.3 KB

CONTRIBUTING.md

File metadata and controls

48 lines (34 loc) · 1.3 KB
Raw

Contributing to plot-showcase

Thanks for your interest in improving this project! Issues and pull requests are welcome.

Getting started

You'll need Node.js 20+.

git clone https://github.com/plot-ws/plot-showcase
cd plot-showcase
npm install
npm run dev      # start the dev server

Before opening a PR, make sure these all pass — CI runs the same checks:

npm run typecheck
npm run build
npm test

Pull requests

  1. Fork the repo and create a branch from main (e.g. feat/my-change).
  2. Keep changes focused; add or update tests where it makes sense.
  3. Use Conventional Commits for your PR title (e.g. feat:, fix:, docs:).
  4. Open the PR and fill in the template.

Connecting to Plot

This project talks to a Plot backend. Grab a publishable app key from the Plot dashboard, or run Plot locally and point the app at it with VITE_PLOT_API_URL. See the docs.

Code of conduct

This project follows the Plot Code of Conduct. By participating, you agree to uphold it.

Questions?

Usage questions are best asked in Discord. Use issues for bugs and feature requests.