docs: replace broken DEVELOPMENT.md references with just setup workflow#482
Conversation
…flow DEVELOPMENT.md was removed in superradcompany#455 but links in README.md and CONTRIBUTING.md were left dangling. Rather than restoring the deleted file, this adds a `just setup` recipe that automates the full development environment setup and updates the contributing guide to reference it. - justfile: add `just setup` for Linux and macOS (macOS is untested) - README.md: point Contributing section to CONTRIBUTING.md only - CONTRIBUTING.md: inline setup instructions, fix test command, fix good-first-issues link to current repo, remove unused refs
There was a problem hiding this comment.
hesitant with automatically passing the -y flag to the apt install and rust install commands. developers should explicitly approve packages being installed. we can allow -y flag in just install
There was a problem hiding this comment.
Removed -y from both apt install and rustup. 6223d28
One thought: we could also accept an optional argument so that just setup -y passes it through for users who want non-interactive installs. Would that be worth adding, or keep it simple for now?
| echo "==> Checking prerequisites..." | ||
| command -v docker &>/dev/null || { echo "error: Docker is required on macOS. Install Docker Desktop."; exit 1; } | ||
| xcode-select -p &>/dev/null || { echo "==> Installing Xcode Command Line Tools..."; xcode-select --install; } | ||
|
|
||
| echo "==> Checking Rust toolchain..." | ||
| if ! command -v rustup &>/dev/null; then | ||
| echo " Rust not found. Installing via rustup..." | ||
| curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y | ||
| source "$HOME/.cargo/env" | ||
| fi |
There was a problem hiding this comment.
nit: this can be a subcommand: say, _install_dev_deps. and we can then have a single setup command given they're identical. pre commit can also be in that step.
There was a problem hiding this comment.
Extracted OS-specific steps into _install-dev-deps (split by [linux]/[macos]) with a single setup recipe that calls it as a dependency. 6223d28
|
appreciate the changes. asides those comment, lgtm! |
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
A note on distro coverage: the Linux |
Bump all microsandbox crates and npm packages from 0.3.10 to 0.3.11. Changes since 0.3.10: - refactor(filesystem): extract shared dir snapshot logic and add inject_init config (#495) - fix(filesystem): fix symlink xattr ops, init listxattr, and update docs (#493) - docs: replace broken DEVELOPMENT.md references with `just setup` workflow (#482) Also includes a minor test fix in agentd session tests (use -c instead of -lc shell flag and add explicit exit 0).
Bump all microsandbox crates and npm packages from 0.3.10 to 0.3.11. Changes since 0.3.10: - refactor(filesystem): extract shared dir snapshot logic and add inject_init config (#495) - fix(filesystem): fix symlink xattr ops, init listxattr, and update docs (#493) - docs: replace broken DEVELOPMENT.md references with `just setup` workflow (#482) Also includes a minor test fix in agentd session tests (use -c instead of -lc shell flag and add explicit exit 0).
3 participants
Summary
DEVELOPMENT.md was removed in #455 but links in README.md and CONTRIBUTING.md remained, leaving new contributors with broken setup instructions.
This PR replaces those broken references with a working
just setuprecipe and updates the contributing guide accordingly.Changes
just setuprecipe that automates the full dev environment setup (system deps, Rust, submodules, build, install, pre-commit hooks)just setup, fix test command (cargo test), fix good-first-issues link pointing to old repo (monoceros-alpha/monocore), remove unused link definitionsNotes
just setup) has been tested end-to-end on Ubuntu 24.04just setup) is untested — review and feedback welcomeCloses #477