File a bug report using the Bug Report issue template. Every report should include:
Export bugs should additionally include the quality preset, board size, and whether the issue is with PNG, JPEG, or SVG.
Use the Feature Request issue template. Describe the problem the feature solves, the proposed behavior, and any alternatives you considered.
| Group | Examples |
|---|---|
Bug, enhancement, security, performance |
Issue type |
status: waiting review, status: discussing, status: blocked, status: on the roadmap |
Workflow state |
scope: mobile, scope: a11y, scope: breaking |
Affected scope |
area: board, area: export, area: auth, area: fen |
Subsystem |
good first issue, help wanted |
Contribution flags |
See CONTRIBUTING.md (github.com) for the full guide.
git checkout -b fix/your-fix
pnpm validate
git commit -m "fix: brief description"
git push origin fix/your-fix
# open a pull request against master
Every PR must:
Closes #N)pnpm validate and CIPRs are merged with squash merge. Branches are deleted automatically after merge.
master is the only long-lived branch. It is always deployable. Create a short-lived branch off master for every change and target master in your PR.
Releases are created manually by the maintainer via workflow_dispatch on the Release workflow. Versioning follows semantic versioning derived from Conventional Commit types:
| Commit type | Version bump |
|---|---|
feat |
minor |
fix, perf, revert |
patch |
feat! / BREAKING CHANGE |
major |
docs, chore, ci, refactor, test |
no release |
Do not file security vulnerabilities as public issues. See SECURITY.md (github.com) for the private disclosure channel.