Unify documentation rules across languages and fix the Python template
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This commit is contained in:
co-authored by
Claude Opus 5
parent
19e9b8f2fa
commit
5c0f2f758f
+5
-6
@@ -16,10 +16,8 @@ template/
|
||||
├── pyproject.toml # Poetry config (ruff, mypy, pytest)
|
||||
├── src/
|
||||
│ ├── __init__.py
|
||||
│ └── core/
|
||||
│ ├── __init__.py
|
||||
│ ├── _version.py # Version fallback for PyInstaller
|
||||
│ └── constants.py # Version extraction from toml + DEBUG mode
|
||||
│ ├── _version.py # Version fallback for PyInstaller
|
||||
│ └── constants.py # Version extraction from toml + DEBUG mode
|
||||
└── tests/
|
||||
├── __init__.py
|
||||
└── test_constants.py # Basic test
|
||||
@@ -28,14 +26,15 @@ template/
|
||||
## Key Features
|
||||
|
||||
- **Version extraction** from `pyproject.toml` with `_version.py` fallback for PyInstaller builds
|
||||
- **DEBUG mode** via `ENV_DEBUG=true` in `.env` (adds " DEV" suffix to version)
|
||||
- **DEBUG mode** via `ENV_DEBUG=true` in `.env` (adds "DEV" suffix to version: v1.2.3DEV)
|
||||
- **loguru** for logging (never print)
|
||||
- **Poetry** for dependency management
|
||||
- **pytest** for testing (no unittest)
|
||||
- **ruff + mypy** for linting and type checking
|
||||
- **ruff + mypy** for linting and type checking (120-character lines)
|
||||
|
||||
## Rules
|
||||
|
||||
- No `.example` suffixes - the folder itself is the separator
|
||||
- Generic/reusable format
|
||||
- Keep files simple and minimal
|
||||
- `.gitignore` is the shared core from `Project template/.gitignore` with `Python/.gitignore` appended
|
||||
|
||||
Reference in New Issue
Block a user