62 lines
2.8 KiB
Markdown
62 lines
2.8 KiB
Markdown
# Dokumentace
|
|
|
|
Personal development documentation — guidelines, conventions, and templates for my projects, structured for use with AI coding assistants.
|
|
|
|
## Purpose
|
|
|
|
This repository is the single source of truth for how I develop software. AI assistants (Claude Code, Cursor, Copilot) are given these documents at the start of each session to understand my conventions before touching any code.
|
|
|
|
## Structure
|
|
|
|
```
|
|
Dokumentace/
|
|
├── Claude/ # AI assistant configuration
|
|
│ ├── CLAUDE.md # Claude Code session instructions
|
|
│ ├── AGENTS.md # Rules for all AI assistants
|
|
│ └── skills/ # Custom Claude Code skills
|
|
│
|
|
├── Python/ # Python development guidelines
|
|
│ ├── DESIGN_DOCUMENT.md # Guidelines for Python applications
|
|
│ ├── DESIGN_DOCUMENT_MODULE.md # Guidelines for Python libraries
|
|
│ ├── TEMPLATE.md # New project template specification
|
|
│ └── prebuild.py # Pre-build script (PyInstaller)
|
|
│
|
|
├── Rust/ # Rust development guidelines
|
|
│ ├── DESIGN_DOCUMENT.md # Guidelines for Rust applications
|
|
│ └── DESIGN_DOCUMENT_LIB.md # Guidelines for Rust libraries
|
|
│
|
|
├── Project template/ # Reusable files for new projects
|
|
│ ├── CHANGELOG.md # Changelog template
|
|
│ └── PROJECT.md # Project documentation template
|
|
│
|
|
└── Zscaler/ # Corporate network setup
|
|
├── NODE_EXTRA_CA_CERTS.md # Instructions for Zscaler cert
|
|
└── ZscalerRootCertificate-2048-SHA256.crt
|
|
```
|
|
|
|
## AI Coding Workflow
|
|
|
|
Each project references these documents so AI assistants operate within consistent rules:
|
|
|
|
- **AGENTS.md** — language-agnostic rules: dependency management, testing, logging, git, versioning
|
|
- **DESIGN_DOCUMENT.md** — Python-specific: code style, tooling (Ruff, mypy, pytest, Poetry), project structure, logging with loguru, distribution via PyInstaller
|
|
- **DESIGN_DOCUMENT_MODULE.md** — same as above, adapted for Python libraries (no sinks, no `.env`, PyPI distribution)
|
|
|
|
## Languages Covered
|
|
|
|
| Language | Guidelines |
|
|
|----------|-----------|
|
|
| Python (application) | `Python/DESIGN_DOCUMENT.md` |
|
|
| Python (library) | `Python/DESIGN_DOCUMENT_MODULE.md` |
|
|
| Rust (application) | `Rust/DESIGN_DOCUMENT.md` |
|
|
| Rust (library) | `Rust/DESIGN_DOCUMENT_LIB.md` |
|
|
|
|
## Key Conventions
|
|
|
|
- **Python tooling:** Poetry · Ruff · mypy · pytest · loguru
|
|
- **No print() for debugging** — loguru everywhere
|
|
- **Type hints required** on all functions
|
|
- **Tests:** pytest only, no unittest, no mocks of the database
|
|
- **Versioning:** semantic, always ask before bumping
|
|
- **Secrets:** `.env` + `python-dotenv`, never committed
|