Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
64 lines (41 loc) · 1.76 KB

CONTRIBUTING.md

File metadata and controls

64 lines (41 loc) · 1.76 KB

Contributing to Glyph

Thanks for your interest in contributing! This guide covers everything you need to get started.

Prerequisites

See the README for required tools (Node.js, pnpm, Rust, Tauri system dependencies).

Development Setup

# Install frontend dependencies
pnpm install

# Run the full desktop app in dev mode
pnpm tauri dev

pnpm tauri dev starts the Vite dev server and the Tauri shell together with hot reload.

Code Quality

This repo enforces quality checks via a Husky pre-commit hook that runs:

pnpm verify   # lint + typecheck + build

You can run these individually:

pnpm lint        # ESLint
pnpm typecheck   # TypeScript compiler checks
pnpm build       # Vite production build

If your change touches Rust code, also run:

cargo check --manifest-path src-tauri/Cargo.toml
cargo test --manifest-path src-tauri/Cargo.toml

Pull Requests

  1. Fork the repo and create a branch from main.
  2. Make your changes with clear, focused commits.
  3. Ensure all checks pass (pnpm verify and cargo check if applicable).
  4. Open a pull request with a clear description of what and why.
  5. Reference any related issues.

Safety-Critical Changes

If your change touches file I/O, save/conflict handling, workspace access, or terminal sessions, review the verification checklist and run the relevant smoke tests.

For context on the security boundaries, see docs/trust-model.md.

Reporting Issues

Use the issue templates to report bugs or request features.

License

By contributing, you agree that your contributions will be licensed under the MIT License.