Visitar URL original
pitchfork/CONTRIBUTING.md at main · jdx/pitchfork · GitHub
Skip to content

Latest commit

 

History

History
37 lines (28 loc) · 1.33 KB

CONTRIBUTING.md

File metadata and controls

37 lines (28 loc) · 1.33 KB

Contributing

See the contributing guide for review expectations and repository conventions.

Development setup

git submodule update --init --recursive
mise install
mise run build

build prepares the embedded web UI before compiling Rust. Use mise run build-dev when you also want to restart your local supervisor. Run mise run ci-dev before committing and inspect the generated changes.

Documentation

mise run docs        # Local VitePress server
mise run build:docs  # Production build and documentation checks

Edit prose in docs/, navigation in docs/.vitepress/config.mts, and styling in docs/.vitepress/theme/. For generated CLI help and settings, edit src/cli/ or src/settings.rs and run mise run render; do not hand-edit docs/cli/. The render task stages the docs directory and generated usage spec. Build the docs again after rendering and review staged changes before committing.

mbx build cache

mise wraps cargo with mbx, so compiled work is shared across checkouts. mise run tasks and mise exec -- cargo … use the wrapper; plain cargo does too once mise is activated in your shell. Builds that set MBX_DISABLE=1, including CI, skip the cache.