add: AGENTS.md

This commit is contained in:
синечка ♡ 2026-08-30 14:08:20 +03:00
parent cad73e0577
commit f55a47f166
2 changed files with 30 additions and 0 deletions

30
AGENTS.md Normal file
View file

@ -0,0 +1,30 @@
# About
This project: Telegram bot for displaying schedule for groups of students
Validate and run project via `uv`
### Commit message rules:
`{fix|add|impl|bot|event|web|any other...}: {message}`
# Folders:
## `./events/`
Separate event system implementation, i.e.: notifications about upcoming lessons
## `./bot/`
Main interactions with bot
## `./models/`
Main implementations
## `./web/`
Folder for static web content
## `./utils/schedule_client.py`
Main schedule database client to communicate with. Autogenerated from private repo, don't modify
# How to run
Copy `./config.example.py` to `./config.py`
Fill all variables in `./config.py`
Run via `uv run main.py`
...anything else???

View file