Plesty Documentation

Workflow

The complete contribution cycle from scaffolding to publishing a tagged release.

The full contribution cycle

1
Scaffold
plesty init device or plesty init experiment — generates project layout, schemas, tests, CI config, pre-push hook
2
Implement
Write connect, disconnect, _write_, _query_, check_errors, check_operatability. Define schemas.
3
Check
uv run plesty check — fix failures, re-run until all gates pass
4
Document
Update docs/index.md and CHANGELOG.md — required by Gate 5
5
Commit
Conventional commits: feat(scope): description. No Co-Authored-By trailers in PLESTY repos.
6
Push
Pre-push hook runs plesty check automatically. Hub repos: push to main. Core repos: push to exp via a feature branch.
7
CI
GitLab pipeline: check → security → deploy (docs) → release (on tag)
8
Publish
git tag vX.Y.Z && git push origin vX.Y.Z — triggers Gate 14: builds wheel and publishes to PyPI

Sections