Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
114 lines (75 loc) · 4.26 KB

CONTRIBUTING.md

File metadata and controls

114 lines (75 loc) · 4.26 KB
Raw

Contributing to Vibe Annotations

First off, thank you for considering contributing to Vibe Annotations! It's people like you that make Vibe Annotations such a great tool.

Code of Conduct

This project and everyone participating in it is governed by the Vibe Annotations Code of Conduct. By participating, you are expected to uphold this code.

How Can I Contribute?

Reporting Bugs

Before creating bug reports, please check existing issues as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible:

  • Use a clear and descriptive title
  • Describe the exact steps which reproduce the problem
  • Provide specific examples to demonstrate the steps
  • Describe the behavior you observed after following the steps
  • Explain which behavior you expected to see instead and why
  • Include screenshots if possible
  • Include your environment details (OS, browser version, etc.)

Suggesting Enhancements

Enhancement suggestions are tracked as GitHub issues. When creating an enhancement suggestion, please include:

  • Use a clear and descriptive title
  • Provide a step-by-step description of the suggested enhancement
  • Provide specific examples to demonstrate the steps
  • Describe the current behavior and explain which behavior you expected to see instead
  • Explain why this enhancement would be useful

Your First Code Contribution

Unsure where to begin contributing? You can start by looking through these issues:

  • Issues labeled good first issue - issues which should only require a few lines of code
  • Issues labeled help wanted - issues which should be a bit more involved than beginner issues

Pull Requests

  1. Fork the repo and create your branch from main
  2. If you've added code that should be tested, add tests
  3. Ensure the test suite passes
  4. Make sure your code follows the existing code style
  5. Issue that pull request!

Development Process

Project Structure

This is a pnpm workspace — one pnpm install at the root resolves everything.

vibe-annotations/
├── packages/
│   ├── extension/   # Chrome extension (WXT build)
│   ├── server/      # MCP server (npm package: vibe-annotations-server)
│   └── website/     # Marketing site & docs (Next.js)
└── README.md

Each package has its own CLAUDE.md with detailed architecture and dev notes.

Extension Development

The extension is built with WXT.

  1. From packages/extension/, run pnpm dev — WXT serves a live-reloading dev build.
  2. Load it in Chrome the first time:
    • Open chrome://extensions/
    • Enable Developer mode
    • Click "Load unpacked" and select packages/extension/.output/chrome-mv3
  3. Make your changes — WXT hot-reloads the content scripts.

Server Development

  1. From packages/server/, install deps: pnpm install (or npm install)
  2. Run it: node lib/server.js (or node bin/cli.js start)
  3. Test your changes against http://127.0.0.1:3846

Code Style

  • Use 2 spaces for indentation
  • Use meaningful variable names
  • Comment your code where necessary
  • Follow the existing code style

Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line

Publishing

Extension Publishing

The Chrome extension is published to the Chrome Web Store by maintainers only.

Server Publishing

The server (packages/server) lives in this monorepo and is published to npm automatically by a GitHub Action (.github/workflows/publish-npm.yml) when changes to packages/server/** land on main. Bump packages/server/package.json's version for an intentional release; otherwise the action patches from the latest npm version.

Licensing

Vibe Annotations is source-available under the PolyForm Shield License 1.0.0 — not an OSI open-source license. You're welcome to read the code and contribute; by submitting a contribution you agree it's licensed under those same terms.

Questions?

Feel free to open an issue with your question or reach out to the maintainers.

Thank you for contributing! 🎉