docs(project): add README, CONTRIBUTING, and CODE_OF_CONDUCT#17
Merged
Conversation
wax911
commented
Jun 30, 2026
wax911
left a comment
wax911
left a comment
Member
Author
There was a problem hiding this comment.
Follow-up review after retargeting:
The PR is now correctly stacked on #16 and the scope is focused.
One correction needed in README before merge:
stackctl syncis described as "Sync images and volumes". That is not the intended command.syncshould mean generated stack drift validation: regenerate canonical stacks and compare them against committedstacks/*.yml. It must not imply image/volume synchronization.
Suggested wording:
Validate generated stack files against committed stacks and report drift
Also, the quick-start install section uses deno install from JSR, but the planned distribution path is compiled binaries and Homebrew. Since JSR publishing was not part of the agreed release plan, mark that as a development-only placeholder or remove it until a JSR publishing decision is made.
- Deno 2.x project structure with deno.json and task definitions - JSR dependencies: @cliffy/command, @std/assert, @std/testing, @std/yaml, @std/dotenv, @std/fs, @std/path - Full CLI command tree with stubs for all 15 issues - Shared interfaces (ProcessRunner, config types, ExitCode) for parallel work - FakeProcessRunner with recording, pre-programmed responses, and dry-run support - CI pipeline: fmt, lint, typecheck, test, coverage, and cross-platform build - .gitignore for generated and environment-specific files
- Minimal README with command table, quick start, and development setup - CONTRIBUTING with issue/PR guidelines, branch/commit conventions - CODE_OF_CONDUCT (Contributor Covenant v1.4)
wax911
force-pushed
the
docs/2-add-readme-contributing-code-of-conduct
branch
from
b88e60d to
2746c83
Compare
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 #2