mirror of
https://github.com/ghndrx/shellmate.git
synced 2026-02-10 06:45:02 +00:00
Play chess in your terminal over SSH. No installs, no accounts. Features: - Beautiful terminal-filling chess board with ANSI colors - Play against Stockfish AI (multiple difficulty levels) - Two-step move interaction with visual feedback - Leaderboard with PostgreSQL persistence - SSH key persistence across restarts Infrastructure: - Docker containerized deployment - CI/CD pipeline for dev/staging/production - Health checks with auto-rollback - Landing page at shellmate.sh Tech: Python 3.12+, asyncssh, python-chess, Stockfish
1.1 KiB
1.1 KiB
Contributing to ShellMate
Thanks for your interest in contributing! 🎉
Branch Strategy
feature/* ──→ develop ──→ master
│ │
staging production
develop— Default branch, all PRs target heremaster— Production releases onlyfeature/*— Feature branches off develop
Development Flow
- Fork the repo
- Create a feature branch from
develop:git checkout develop git pull origin develop git checkout -b feature/my-feature - Make your changes
- Run tests:
pytest tests/ -v - Run linting:
ruff check src/ - Push and create a PR to
develop
Code Style
- Python 3.11+
- Type hints required
- Ruff for linting
- 100 char line limit
Commit Messages
Use conventional commits:
feat:New featurefix:Bug fixdocs:Documentationrefactor:Code refactortest:Testschore:Maintenance
Release Process
- PRs merged to
developdeploy to staging - When ready, merge
develop→master - Master deploys to production automatically