Contributing

Contributions welcome!

Development Setup

git clone https://github.com/upship-ai/giddyanne.git
cd giddyanne

# Build everything
make

# Install dev dependencies
.venv/bin/pip install -e ".[dev]"

Running Tests

# Linter
.venv/bin/ruff check .

# Tests
.venv/bin/pytest

Project Structure

giddyanne/
├── cmd/giddy/main.go    # Go CLI
├── http_main.py         # Python HTTP server
├── mcp_main.py          # Python MCP server
├── src/                 # Python source (engine, startup, chunker, embeddings, vectorstore, etc.)
├── emacs/               # Emacs package
└── vscode/              # VSCode extension

For how these pieces fit together — the indexing pipeline, search internals, file watching, and design decisions — see Architecture.

Help Wanted

Here's what would help most:

Windows Support

The Python server should work, but needs testing and documentation: - Test installation and server on Windows - Document any needed changes (paths, process management) - Update Makefile or add Windows-specific install script

Vim/Neovim Plugin

A plugin that calls the CLI and populates quickfix: - giddy find integration with fzf or telescope - Results to quickfix list - Basic commands: up, down, status

Open an issue to discuss or submit a PR.