Stop tracking personal workflow artifacts at repo root, add CI and MIT license, align README and agent skills with artifacts/ defaults, and enable Ruff in dev/CI so releases are verifiable without local-only runs. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> Co-authored-by: Cursor <cursoragent@cursor.com>
1.1 KiB
1.1 KiB
Contributing
Versioning
This project follows Semantic Versioning:
- PATCH — bug fixes, documentation-only changes
- MINOR — backward-compatible features (new commands, options, schema fields)
- MAJOR — breaking changes to CLI contracts, config keys, or artifact schemas
Release notes and test baselines are recorded in CHANGELOG.md.
Development setup
uv pip install -e ".[dev]"
uv run pytest -q
Optional Textual UI: uv pip install -e ".[tui]".
Pull requests
- Write or extend tests for behavior changes.
- Run
uv run pytest -qlocally (CI runs the same). - Keep commits focused; use imperative subject lines.
- Do not commit personal library paths, workflow artifacts (
artifacts/, root CSV/JSON), or API keys from~/.vlm/config.yaml.
Code style
- Python 3.10+, 4-space indentation, type hints on public APIs.
- Use absolute imports in package code:
from vlm.module import ...(not relative imports in new code). uv run ruff check src testswhen Ruff is installed via[dev].