Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
43 lines (29 loc) · 1.62 KB

CONTRIBUTING.md

File metadata and controls

43 lines (29 loc) · 1.62 KB
Raw

Contributing to Benchfinity

Benchfinity is a TypeScript, React, and Vite app for generating Gridfinity-compatible workbench baseplates. Contributions should keep the existing V1 generator stable while moving the Workbench roadmap forward through GitHub Issues.

Development Setup

Prerequisites:

  • Node.js 22 or newer
  • npm
  • Git

Commands:

npm install
npm run test
npm run build
npm audit

Use npm run dev for local browser verification.

Workflow

  • Work from an issue when possible.
  • Branch from develop using feature/{issue-number}-{short-description}.
  • Keep pull requests focused and small enough to review.
  • Use conventional commit subjects.
  • Do not use the Bambu Studio CLI for automated validation on this project. Validate 3MF behavior through tests, package inspection, and manual GUI import when needed.

Quality Bar

  • Keep npm run test, npm run build, and npm audit green.
  • Preserve existing STL, ZIP, 3MF, geometry, and preview behavior unless the issue explicitly changes it.
  • Add focused tests for geometry, export, validation, and persistence behavior when touched.
  • Keep src/App.tsx centered on top-level state and orchestration. Use src/components, src/geometry, and src/export for focused implementation.

Legal

Benchfinity is licensed under AGPL-3.0-only; contributions are accepted under the same license.

This project uses the Developer Certificate of Origin: sign off each commit with git commit -s to certify it is your own work and may be distributed under the project license (and any commercial license the maintainers may also offer).