Contributing to IntellyWeave

January 12, 2026 · View on GitHub

How to set up your development environment, run tests, and contribute code.

Overview

IntellyWeave welcomes contributions! This section covers everything you need to get started as a contributor.

Contributing Documents

Document	Description
Development Setup	Set up your dev environment
Testing	Run and write tests
Upstream Syncing	Sync with Weaviate Elysia
Git Subtree Governance	How we manage upstream

Quick Start for Contributors

flowchart LR
    A[Fork & Clone] --> B[Setup Dev Env]
    B --> C[Create Branch]
    C --> D[Make Changes]
    D --> E[Test]
    E --> F[Commit]
    F --> G[Create PR]

1. Fork and Clone

git clone https://github.com/YOUR_USERNAME/intellyweave.git
cd intellyweave

2. Set Up Development Environment

scripts/setup.sh

3. Create a Feature Branch

git checkout -b feat/your-feature-name

4. Make Changes and Test

# Run backend tests
cd backend && source .venv/bin/activate && pytest tests/

# Run frontend lint
cd frontend && pnpm test

5. Commit with Conventional Commits

git commit -m "feat: add new entity extraction type"

6. Create Pull Request

Push your branch and create a PR against main.

Commit Message Convention

Prefix	Use For
`feat:`	New features
`fix:`	Bug fixes
`docs:`	Documentation
`refactor:`	Code restructuring
`test:`	Test changes
`chore:`	Maintenance

Examples:

feat: add cryptonym entity extraction
fix: resolve WebSocket connection timeout
docs: update installation guide
refactor: reorganize agent tools
test: add courthouse debate integration tests
chore: update dependencies

Pull Request Process

Ensure tests pass - All CI checks must be green
Update documentation - If you changed behavior
Follow code style - See AGENTS.md for conventions
Sign commits - DCO sign-off required

Code Review

All PRs require review before merge. Reviewers check for:

Code quality and style consistency
Test coverage
Documentation updates
Security considerations