Skip to content

docs: update contributor setup instructions - #32

Merged
haseebahmed248 merged 3 commits into
haseebahmed248:mainfrom
Nomee-123:update-contributor-docs
Sep 7, 2026
Merged

haseebahmed248 merged 3 commits into
haseebahmed248:mainfrom
Nomee-123:update-contributor-docs

Conversation

@Nomee-123

Copy link
Copy Markdown
Contributor

Summary

  • Document Node.js 22+ development setup
  • Add npm install, build, check, and test commands
  • Document the repository-local ./gs CLI wrapper
  • Document the executable document-Q&A example
  • Clarify repository-development vs installed-package commands
  • Remove the outdated setup placeholder

Verification

  • npm install — passed
  • npm run build — passed
  • npm 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 passed
  • npm test — 40/43 passed; 3 existing unrelated test failures

Closes #21

Signed-off-by: Nomee Singh <singhnomee@gmail.com>

@haseebahmed248 haseebahmed248 left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

A
Merge remote-tracking branch 'upstream/main' into update-contributor-docs
wq
Signed-off-by: Nomee Singh <singhnomee@gmail.com>
@haseebahmed248
haseebahmed248 merged commit 9ed769f into haseebahmed248:main Sep 7, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update contributor setup instructions for Stage 1

2 participants