chore: simplify contributing workflow and documentation#92
Merged
Conversation
Restructure mise tasks so only primary contributor commands are public. Rewrite CONTRIBUTING.md to focus on prerequisites, quick start, and main tasks. Move code/CLI style guidance into STYLE_GUIDE.md. Add fmt, lint, ci, check, version, and test:e2e as top-level public tasks. Hide internal build/publish/docker tasks behind hide=true. Extract sandbox runner script to build/scripts/run-sandbox.sh and unify cluster:sandbox as the public entrypoint. Signed-off-by: Drew Newberry <anewberry@nvidia.com>
Rename the build/ directory to tasks/ for clarity, updating all references across mise config, CI pipelines, Dockerfiles, architecture docs, and internal scripts. Consolidate mise run cluster and mise run cluster:build into a single cluster task that bootstraps if no cluster is running, then performs incremental deploy. Add a public sandbox task (mise run sandbox) that creates a sandbox on the running cluster via ncl. Move commit message guidance under the Pull Requests section in CONTRIBUTING.md, replace ncl sandbox create with mise run sandbox in Getting Started, and remove version from the main tasks table. Signed-off-by: Drew Newberry <anewberry@nvidia.com>
Signed-off-by: Drew Newberry <anewberry@nvidia.com>
Signed-off-by: Drew Newberry <anewberry@nvidia.com>
Signed-off-by: Drew Newberry <anewberry@nvidia.com>
Signed-off-by: Drew Newberry <anewberry@nvidia.com>
Signed-off-by: Drew Newberry <anewberry@nvidia.com>
Signed-off-by: Drew Newberry <anewberry@nvidia.com>
Signed-off-by: Drew Newberry <anewberry@nvidia.com>
Signed-off-by: Drew Newberry <anewberry@nvidia.com>
…n it Signed-off-by: Drew Newberry <anewberry@nvidia.com>
Signed-off-by: Drew Newberry <anewberry@nvidia.com>
Signed-off-by: Drew Newberry <anewberry@nvidia.com>
Rename scripts/bin/ncl to scripts/bin/nemoclaw so the local dev shortcut matches the actual binary name. Update all references across task definitions, shell scripts, e2e tests, architecture docs, examples, agent skills, and config files.
|
All contributors have signed the DCO ✍️ ✅ |
Collaborator
Author
|
I have read the DCO document and I hereby sign the DCO. |
drew
added a commit
that referenced
this pull request
Mar 16, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #91
Summary
Simplifies the contributor experience by reducing the public
misetask surface to six primary commands:mise run clustermise run sandboxmise run testmise run e2emise run cimise run cleanAll internal build, publish, docker, fmt, lint, and check tasks are hidden (
hide = true) so contributors see only what matters.nclfingerprint-based rebuildThe
nclwrapper (scripts/bin/ncl) now uses git-based fingerprinting — adapted from the cluster deploy logic — instead of runningcargo buildon every invocation. It tracks HEAD commit and SHA-256 hashes of dirty files in thenavigator-clidependency closure (navigator-cli,navigator-core,navigator-bootstrap,navigator-policy,navigator-providers,navigator-tui,proto/,Cargo.toml,Cargo.lock). State is persisted to.cache/ncl-build.state. When no relevant files have changed,nclskips the build entirely (~0.1s vs ~2s).Other changes
build/directory totasks/for clarity.CONTRIBUTING.mdto be concise and task-focused.STYLE_GUIDE.md.TESTING.mdwith test patterns and conventions.cluster:deploy→cluster(primary entrypoint); oldcluster:build→cluster:build:full(hidden).sandboxandcluster:sandboxinto a singlesandboxtask, extracting shell logic intotasks/scripts/run-sandbox.sh.Test Plan
mise tasks lsshows only the six intended public tasks.nclfingerprinting verified: skips build on no-op (~0.1s), rebuilds on relevant source changes, rebuilds when binary is missing, ignores irrelevant file changes.