Instruction file imported from wow-apps/youtube-id-py (
.github/instructions/general.instructions.md). Copyright stays with the author.
General Project Instructions
Project Overview
youtube-id is a Python library for generating YouTube-style short IDs from numbers. Lightweight, fast, and reversible base62 encoder with optional obfuscation.
Tech Stack
- Python 3.10+
- Poetry for dependency management
- ruff for linting and formatting
- mypy for type checking
- pytest for testing
- pymarkdownlnt for markdown linting
Quality Requirements
All code must pass automated quality checks before merging:
ruff check .- no linting errorsruff format --check .- no formatting issuesmypy yid_py/- no type errorspytest --cov=yid_py --cov-fail-under=95- tests pass with 95%+ coverage
Branch Naming
feature/- new featuresfix/- bug fixesdocs/- documentation updatesrefactor/- code refactoringtest/- test additions
PR Title Format
Must start with one of: feature/, fix/, docs/, refactor/, test/
(case-insensitive)
Important Notes
- Do NOT suggest changes that conflict with ruff formatting
- ruff is the authority for Python code style, not manual preferences
- All Python code must have type hints
- Zero external dependencies in production code