be5fe04a90
- SPEC.md: full project specification from design discussion - schema.sql: SQLite database schema - db.py: database wrapper with all query functions - bot.py: telegram bot entrypoint - commands.py: all command handlers with admin/creator guards - cron.py: daily reminder job - requirements.txt: python-telegram-bot, dateparser - README.md, CONTRIBUTING.md - .gitignore
35 lines
731 B
Markdown
35 lines
731 B
Markdown
# Contributing to JIGAIDO
|
|
|
|
## Development Setup
|
|
|
|
```bash
|
|
git clone https://git.fbrns.co/shoko/jigaido.git
|
|
cd jigaido
|
|
python -m venv venv
|
|
source venv/bin/activate
|
|
pip install -r requirements.txt
|
|
|
|
# Run bot
|
|
export JIGAIDO_BOT_TOKEN="test:token"
|
|
python bot.py
|
|
```
|
|
|
|
## Code Style
|
|
|
|
- Python (no strict formatter enforced yet)
|
|
- Async/await for Telegram handlers
|
|
- Type hints where obvious
|
|
- Docstrings for public functions
|
|
|
|
## Pull Request Workflow
|
|
|
|
1. Branch from `main`
|
|
2. Make changes
|
|
3. Test locally
|
|
4. Open PR with description of what changed and why
|
|
5. Someone reviews and merges
|
|
|
|
## Issues
|
|
|
|
Use GitHub Issues for bugs and feature requests. Please be specific — include error messages, steps to reproduce, and your environment.
|