-
Notifications
You must be signed in to change notification settings - Fork 72
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Show steps for initializing a new Git repo #1081
Show steps for initializing a new Git repo #1081
Conversation
📦 Package Size: 5268 KB |
Coverage summary from CodacySee diff coverage on Codacy
Coverage variation details
Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: Diff coverage details
Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: See your quality gate settings Change summary preferencesCodacy stopped sending the deprecated coverage status on June 5th, 2024. Learn more |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good. Would it make sense to perhaps link to the git book? If you're unaware of how to create a git repo, more docs would probably be a good thing. https://git-scm.com/book/en/v2
Excellent idea! I'll toss that in there too! |
It can be a little confusing when you try to run Chromatic in a directory that isn't a Git repo. You end up going through a couple of error steps before you finally get to a workable state. This adds a suggestion how to initialize an empty Git repo and add a single commit. Therefore, you only go through 1 error before you can run a build.
📦 Published PR as canary version:
11.12.0--canary.1081.11220007939.0
✨ Test out this PR locally via:
npm install chromatic@11.12.0--canary.1081.11220007939.0 # or yarn add chromatic@11.12.0--canary.1081.11220007939.0