Skip to content

Contributing

Imaginook is free software (AGPL-3.0) and contributions are welcome. This page summarises the flow; the authoritative source is CONTRIBUTING.md in the repo.

Before you start

  • Every change starts with an issue — open or pick one before writing code. For security issues, follow the Security Policy; never open a public issue for a vulnerability.
  • Get set up with Local development.

Branching & commits

  • develop is the integration branch — open PRs against it. main is production, updated via release PRs only.
  • Branch from develop: feature/<issue#>-short-slug (or fix/…).
  • Use Conventional Commits (feat(editor): …, fix(files): …, docs: …). Reference the issue with Closes #N.
  • PRs are squash-merged into develop; the squash title must be a valid Conventional Commit (CI-enforced).

Definition of Done

  • Linked to an issue and a milestone.
  • Tests added/updated and green in CI; formatting and the build pass.
  • Docs updated where relevant.
  • No new remote-code-execution, path-traversal, or SSRF surface; inputs validated and output escaped.

Contributions are accepted under the project's AGPL-3.0 license.

AGPL-3.0 · built in the open.