Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
45 lines (28 loc) · 1.45 KB

CONTRIBUTING.md

File metadata and controls

45 lines (28 loc) · 1.45 KB

Contributing to Escape CLI

Development workflow

The Escape CLI source of truth lives in the Escape Technologies product monorepo (private, GitLab). This GitHub repository is a read-only mirror — it exists for public auditability, install scripts, and GitHub Releases via goreleaser.

Pull requests opened on this GitHub repository will not be reviewed or merged.

If you found a bug or want to suggest a feature, please open an issue and the team will handle it internally.

For Escape team members

All CLI development happens inside the monorepo under packages/cli/. Changes are automatically mirrored to this GitHub repository on every merge to prod.

Common commands (run from the monorepo root)

# Regenerate Go models after a public-api spec change
just cli-sync

# Run unit tests
just cli-test

# Lint
just cli-lint

# Build binary locally
just cli-build

Releasing a new version

# 1. Bump version and commit
just cli-release patch   # bug fixes, small improvements → x.y.Z
just cli-release minor   # new commands or features → x.Y.0

# 2. Open MR, get review, merge to prod

That's it. CI automatically mirrors the code to GitHub and pushes the version tag — goreleaser fires and publishes the GitHub Release, Docker image, and binaries.

For a major version bump (X.0.0, breaking changes), update packages/cli/version.txt manually and commit.