Repository navigation
docs: update contributor setup instructions - #32
Merged
haseebahmed248 merged 3 commits intoSep 7, 2026
Merged
Conversation
Signed-off-by: Nomee Singh <singhnomee@gmail.com>
haseebahmed248
requested changes
Sep 5, 2026
haseebahmed248
left a comment
Owner
There was a problem hiding this comment.
Thanks for taking this on. The structure is clear, and the distinction between the repository wrapper and installed CLI is useful.
Two changes before we merge:
- Please update the branch from the latest main and rerun verification. Current main has 55 tests and all of them pass; the 40/43 result came from the older base, so it should not remain in the PR description.
- For a fresh clone, please use npm ci and document npm run check:generated as a separate command. The generated-contract check is part of #21 and is not included in npm run check.
I applied this documentation change to the latest main locally and confirmed that build, check, check:generated, all 55 tests, and all five documented ./gs example commands pass.
This was referenced Sep 6, 2026
Signed-off-by: Nomee Singh <singhnomee@gmail.com>
haseebahmed248
approved these changes
Sep 7, 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
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.
Summary
./gsCLI wrapperVerification
npm install— passednpm run build— passednpm run check— passed./gs check examples/document-qa/answer.guard— passed./gs compile examples/document-qa/answer.guard— passed./gs generate examples/document-qa/answer.guard— passed./gs run examples/document-qa/answer.guard— passed./gs test examples/document-qa/answer.guard— 11/11 scenarios passednpm test— 40/43 passed; 3 existing unrelated test failuresCloses #21