Skip to content

Maintenance

BilgeGates edited this page Jun 28, 2026 · 3 revisions

Maintenance

Reporting bugs

File a bug report using the Bug Report issue template. Every report should include:

  1. A one-sentence summary of the defect.
  2. Numbered reproduction steps from a clean session.
  3. Expected and actual behavior.
  4. Browser, OS, and device (desktop or mobile).
  5. Any console errors or stack traces.

Export bugs should additionally include the quality preset, board size, and whether the issue is with PNG, JPEG, or SVG.

Requesting features

Use the Feature Request issue template. Describe the problem the feature solves, the proposed behavior, and any alternatives you considered.

Labels

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

Contributing

See CONTRIBUTING.md 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:

  • Reference a closing issue (Closes #N)
  • Use a Conventional Commit title
  • Pass pnpm validate and CI

PRs are merged with squash merge. Branches are deleted automatically after merge.

Branch model

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.

Release

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

Security

Do not file security vulnerabilities as public issues. See SECURITY.md for the private disclosure channel.

References

Clone this wiki locally