Open source
Contribute to Justflows
Justflows is developed in the open. All development work, from bug reports to pull requests, happens in JustFlows/justflows-ce-development. Releases are then published to JustFlows/justflows-ce.
Report a bug or suggest a feature
Open an issue in justflows-ce-development. The most useful reports say which version you run, what you expected, what happened instead, and how to reproduce it.
Send a pull request
- Branch off
developwith a prefixed name:feature/,fix/,bug/,patch/,docs/,refactor/,test/orchore/. Other branch names are rejected. - Sign off every commit (
git commit -s). Justflows uses the Developer Certificate of Origin. - Open the pull request into
develop. Tests, typechecks, the dependency audit and CodeQL run on that PR. - Contributions to core are licensed under MIT. Bundled plugins and themes keep their own license.
git fetch origin
git checkout develop
git pull origin develop
git checkout -b feature/short-description
# make changes, commit with -s
git push -u origin HEAD
Before you open the PR, run the checks locally from the repository root:
pnpm install
pnpm typecheck
pnpm test
Build a plugin or theme
Start a plugin by copying
plugins/hello-world and changing its id, manifest and source. The docs folder covers the plugin SDK, themes, blocks, hooks and packaging.Found a security issue?
Please do not open a public issue. Email security@justflows.com with a description, its impact, steps to reproduce and the affected version.
Open justflows-ce-development