Contributing
Contributions are welcome. Pinflow is open source under the GNU General Public License v3.0 or later .
Before you start
- Build, run, and architecture notes live in Local development and Architecture at a glance.
- For bugs and feature ideas, please open an issue before a large PR so we can discuss the approach first.
Pull request basics
- Fork the repo and create a topic branch.
- Keep changes focused, and match the style of the surrounding code.
- Make sure the app builds (
npm run buildinapps/desktop) and the Python service imports cleanly. - If you change a feature, update its documentation page in the same PR —
docs live in
apps/docs/content/, so they version with the code. - Open the PR and address review feedback.
Code conventions
- Keep things modular. Each feature lives in its own folder (frontend) or module (backend) with a narrow surface, no cross-imports between sibling feature folders. If a file grows past ~200 lines or mixes concerns, split it.
- Match the conventions of the code you’re editing — naming, comment density, and idiom.
Licensing of contributions
By submitting a contribution, you certify that you wrote it (or otherwise have the right to submit it) and agree to license it under the terms above.
Last updated on