Contributing Guide

Contributing Guide

This page summarizes the workflow. Read CONTRIBUTING.md for full rules.

Before you start

1. Star the repo. The star-check workflow blocks unstarred merges.
2. Read CONTRIBUTING.md.
3. Pick an open issue or open a new one.
4. Comment "I would like to work on this" to get assigned.

Workflow

1. Fork the repo.
2. Create a branch: feat/your-feature or fix/your-bug.
3. Write tests first. Watch them fail. Then write code.
4. Run bun run build, bun run test, and bun run typecheck.
5. Open a PR with a type: short description title.
6. Link the issue with Closes #N.

PR title format

Your title sets the type label automatically:

Prefix	Meaning
feat:	New feature
fix:	Bug fix
docs:	Documentation
test:	Tests
refactor:	Refactor
perf:	Performance
style:	Design or UX

Code rules

• Match the style of the surrounding code.
• Call this.markDirty() in widget setters that change rendering.
• Check caps.unicode before drawing Unicode. Provide an ASCII fallback.
• No new any types without an inline comment explaining why.
• One PR, one focus. No unrelated refactors.

Review

A maintainer reviews each PR for spec compliance and code quality. Fix the flagged items and push. The reviewer approves once both pass.

GSSoC 2026

Read the point system. Points apply after your PR merges and the maintainer adds the gssoc:approved label.