Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
45 lines (32 loc) · 893 Bytes

CONTRIBUTING.md

File metadata and controls

45 lines (32 loc) · 893 Bytes

Contributing to Jarvis Orb

Thanks for your interest in contributing!

Getting Started

git clone https://github.com/thestack-ai/jarvis-orb.git
cd jarvis-orb

Brain (Python)

cd brain
uv venv .venv && source .venv/bin/activate
uv pip install aiosqlite websockets mcp pytest pytest-asyncio
python -m pytest tests/ -v

Orb (Tauri + Three.js)

cd orb
pnpm install
pnpm tauri dev

Pull Requests

  1. Fork the repo and create a feature branch
  2. Make your changes
  3. Run tests: cd brain && python -m pytest tests/ -v
  4. Submit a PR with a clear description

Reporting Bugs

Open an issue at GitHub Issues with:

  • Steps to reproduce
  • Expected vs actual behavior
  • OS and Python version

License

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