Scrivr
Contributing

Contributing to Scrivr

How to open issues, propose changes, and submit pull requests.

Thank you for your interest in contributing to Scrivr! This document explains how to engage with the project, report bugs, and get your changes merged.

Before You Start

  • Search existing issues and PRs before opening a new one — your problem or idea may already be tracked.
  • Open a discussion (GitHub Discussions) for large features or architectural changes before writing code. This prevents wasted effort.
  • Open an issue for bug reports. Include a minimal reproduction and the expected vs actual behaviour.

Branch Naming

TypeFormatExample
Featurefeat/short-descriptionfeat/image-resize-handles
Bug fixfix/short-descriptionfix/cursor-position-after-undo
Documentationdocs/short-descriptiondocs/api-reference-updates
Refactorrefactor/short-descriptionrefactor/char-map-interval-tree

Always branch from main.

Pull Request Process

  1. Fork the repository and create your branch (see above).
  2. Make your changes — follow the coding conventions.
  3. Run turbo test and ensure all tests pass.
  4. Run pnpm lint — zero errors and zero warnings required.
  5. Update the relevant documentation page in apps/docs/content/docs/.
  6. Open a Pull Request against main with a clear description of what changed and why.
  7. A maintainer will review your PR, request changes if needed, and merge when ready.

Issue Labels

LabelMeaning
bugConfirmed bug with reproduction steps
enhancementNew feature or improvement
good first issueWell-scoped, beginner-friendly
needs-triageNot yet reviewed by a maintainer
help wantedMaintainers welcome external contributions

Text Measurer

Class reference for TextMeasurer.

Local Setup

Clone the repo, install dependencies, and run the monorepo locally.

On this page

Before You StartBranch NamingPull Request ProcessIssue Labels