Thank you for your interest in contributing to Athar! We welcome issues, PRs, adapters for new agent frameworks, UI improvements, and documentation enhancements.
git clone https://github.com/Abdur-Rafay-AR/athar.git
cd athar
# Create virtual environment
python -m venv venv
# Activate virtual environment
# Windows:
venv\Scripts\activate
# Linux/macOS:
source venv/bin/activatepip install -e ".[dev]"Athar uses Python's standard unittest and pytest.
# Run using standard library unittest:
python -m unittest discover -s tests
# Or run with pytest:
pytestTo start the local UI and API server during development:
# Run Athar server
athar --port 4173
# Or on Windows using helper:
run-local.cmdThen visit http://localhost:4173 in your browser.
- Branch Naming: Use descriptive prefixes like
feat/,fix/,docs/,adapter/. - Tests: Ensure any new features or bug fixes include corresponding unit tests under
tests/. - No Breaking Changes to Core Decorator: Keep
@tracedlightweight and non-intrusive. - Clean Commits: Write clear, concise commit messages.