Skip to main content

​
Overview

We welcome contributions from the community! Whether you’re fixing bugs, adding features, improving docs, or sharing ideas.

​
Quick Start

1

Fork & Clone

git clone https://github.com/YOUR_USERNAME/sxth-mind.git
cd sxth-mind
2

Install Dependencies

pip install -e ".[dev,openai,api,sqlite]"
3

Run Tests

pytest

​
Ways to Contribute

New Adapters

Build domain-specific adapters (fitness, support, education)

Storage Backends

Add Redis, PostgreSQL, MongoDB support

LLM Providers

Integrate Anthropic, Gemini, local models

Documentation

Improve docs, add examples, fix typos

​
Development Workflow

​
Code Style

We use Ruff for linting and formatting: 
ruff check .        # Lint
ruff check . --fix  # Auto-fix issues

​
Type Checking

We use strict mypy: 
mypy sxth_mind

​
Running Tests

pytest                    # All tests
pytest tests/test_mind.py # Specific file
pytest -v                 # Verbose output

​
Pull Request Process

  1. Create a branch for your changes: 
    git checkout -b feature/my-new-feature
  2. Make your changes with clear, focused commits
  3. Add tests for new functionality
  4. Run the full test suite: 
    pytest && ruff check . && mypy sxth_mind
  5. Open a PR with:
    • Clear description of what changed
    • Link to any related issues
    • Screenshots/examples if applicable

​
Code of Conduct

Be kind. Be respectful. Assume good intent. We’re building something useful together. Constructive feedback is welcome; personal attacks are not.

Full Contributing Guide

See the complete contributing guidelines on GitHub