Repository navigation
docs: make npm alpha easier to find and install - #53
Open
muhammadanas667 wants to merge 1 commit into
Open
muhammadanas667 wants to merge 1 commit into
muhammadanas667 wants to merge 1 commit into
Conversation
haseebahmed248
requested changes
Sep 9, 2026
haseebahmed248
left a comment
Owner
There was a problem hiding this comment.
Thanks Anas, the badge and alpha warning look good. A few things before merging:
- In both READMEs, add
npx guardstep --versionandnpx guardstep --helpafter installation. Usenpxfor the installed-package examples too, since a local npm install does not put the CLI on the shell PATH. Keep./gsfor repository development. - Fill in the PR description with
Closes #30, a short summary, and the checks you actually ran. - Add the required DCO
Signed-off-byline to your commit.
I verified a fresh install and both CLI aliases report 0.1.0-alpha.1. Please test the updated instructions from a fresh directory and include the results. Thanks for picking this up!
6 tasks done
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
Related issue
Closes #
Changes
Validation
npm run checknpm run check:generatednpm testAdditional validation:
Risk and compatibility
Checklist
Signed-off-byline.