Contributing
Annot is open source under Apache-2.0. PRs welcome — bug fixes, docs improvements, new annotation tools, new storage backends. We’re especially keen to grow the Playwright-side recipes and the headless annotator’s coverage of the editor’s tool surface.
Topics
Section titled “Topics”- Local setup — clone, install, run the web app + the headless tests.
- Sending a PR — branch convention, commit message style, what CI checks before merge.
Code of conduct
Section titled “Code of conduct”Be kind. We follow the Contributor Covenant.
Issue triage
Section titled “Issue triage”Open issues at
github.com/ingcreators/annot/issues.
Bugs with a reproduction (screenshot + reproduction steps) move
fastest. For larger features, prefer opening a discussion or
draft PR first — the
docs/plans/
folder is where we work out designs before code.
Plan-first work
Section titled “Plan-first work”For anything bigger than a single-file fix, we write a plan doc
in docs/plans/<slug>.md before the implementation PR. The plan
lifecycle is:
- Draft — under discussion
- Queued — approved, waiting for capacity
- In progress — work has started
- Done — moved to
docs/plans/_done/
See docs/plans/README.md
for the full lifecycle.