Skip to content

Contributing

Contribute to Yap with reproducible platform reports, Go and frontend tests, source-backed documentation, and conventional commits.

We welcome contributions to Yap. This guide explains how to get involved.

Ways to Contribute

  • Bug Reports — Found a bug? Open an issue
  • Feature Requests — Have an idea? Start a discussion
  • Code — Fix bugs or implement features
  • Documentation — Improve docs or add examples
  • Testing — Test on different platforms

Getting Started

  1. Fork the repository on GitHub
  2. Clone your fork locally
  3. Set up the development environment (see Building)
  4. Create a branch for your changes
git clone https://github.com/YOUR_USERNAME/yap.git
cd yap
git checkout -b feature/your-feature-name

Development Workflow

1. Make Changes

Edit code, add features, fix bugs.

2. Test Locally

go test ./...
npm --prefix frontend test
npm --prefix frontend run build
wails dev

Use YAP_CONFIG_DIR (available in v0.5.0) to isolate development data. Native audio, hotkey, and runtime behavior must be checked on the affected OS; browser tests alone do not verify Windows/Linux installation. See Building.

Test your changes thoroughly:

  • Does the feature work as expected?
  • Are there any regressions?
  • Test on your platform

3. Commit Changes

We use Conventional Commits:

# Feature
git commit -m "feat: add support for custom hotkeys"

# Bug fix
git commit -m "fix: resolve crash when no microphone connected"

# Documentation
git commit -m "docs: update installation instructions"

# Refactoring
git commit -m "refactor: simplify audio recording logic"

# Chore
git commit -m "chore: update dependencies"

Commit types:

  • feat — New feature
  • fix — Bug fix
  • docs — Documentation only
  • style — Formatting, no code change
  • refactor — Code change that neither fixes nor adds
  • test — Adding tests
  • chore — Maintenance tasks

4. Push and Create PR

git push origin feature/your-feature-name

Then open a Pull Request on GitHub.

Pull Request Guidelines

Title

Use conventional commit format:

feat: add dark mode toggle
fix: correct transcription timing

Description

Include:

  • What changes were made
  • Why the changes were made
  • How to test the changes
  • Screenshots (for UI changes)

Checklist

Before submitting:

  • Code builds without errors
  • Code follows existing style
  • Changes are tested
  • Commit messages follow convention
  • Documentation updated (if needed)

Code Style

Go

  • Follow standard Go conventions
  • Run go fmt before committing
  • Use meaningful variable names

TypeScript/React

  • Use TypeScript strict mode
  • Follow existing component patterns
  • Keep components focused

Reporting Issues

Bug Reports

Include:

  • Platform (macOS version, Windows version, Linux distro)
  • Yap version
  • Steps to reproduce
  • Expected vs actual behavior
  • Error messages (if any)
  • CPU architecture, selected model/provider, and relevant logs (remove credentials and private content)

For documentation changes, distinguish stable release behavior from unreleased main. Label development screenshots and sample data, and check instructions against source rather than copying old README claims.

Feature Requests

Include:

  • Use case description
  • Proposed solution
  • Alternatives considered

Getting Help

  • Discussions — For questions and ideas
  • Issues — For bugs and feature requests
  • Pull Requests — For code contributions

License

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