Files
dl-organizer/CONTRIBUTING.md
T
6f0df5a774 release: v0.2.0 repository hygiene, CI, and docs sync
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>
2026-06-01 15:32:03 +08:00

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

  1. Write or extend tests for behavior changes.
  2. Run uv run pytest -q locally (CI runs the same).
  3. Keep commits focused; use imperative subject lines.
  4. 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 tests when Ruff is installed via [dev].