-
Notifications
You must be signed in to change notification settings - Fork 9
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
Update README.md #746
base: main
Are you sure you want to change the base?
Update README.md #746
Conversation
Codecov Report
@@ Coverage Diff @@
## main #746 +/- ##
=======================================
Coverage 98.62% 98.62%
=======================================
Files 490 490
Lines 4227 4227
Branches 663 663
=======================================
Hits 4169 4169
Misses 58 58 📣 We’re building smart automated test selection to slash your CI/CD build times. 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.
Great! 🚀
What do you think about remove in CONTRIBUTING.md
the duplicate text?
|
||
Use `yarn build` to build the entire project and generate the `lib` distribution folder. For a better development experience, use `yarn test:watch` to execute jest tests in watch mode and `yarn storybook` to start the storybook dev server. | ||
|
||
> #### Running tests |
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.
> #### Running tests | |
#### Running tests |
The result expected here is to be a h4 in markdown, right?
If yes, do the same thing in the next topics.
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.
very good! 😄 I only raised two points to discuss
|
||
The documentation uses the local built version of bold (from the `lib/` folder), so make sure to run `yarn build` every time you want the changes from the bold components take effect on the Gatsby site generation. | ||
|
||
> #### Releasing a new version |
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.
idk 🤔 I think we could remove this section here, is about something that not all contributors can do... what do you think?
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.
Good point, maybe we can have some private doc to put thing like this
@@ -21,34 +43,83 @@ npm install bold-ui --save | |||
yarn add bold-ui --save | |||
``` | |||
|
|||
### Font family: IBM Plex Sans | |||
> IBM Plex Sans Font family |
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.
since we are showing this info here, I think the website phrase about it would be nice too
Bold was designed to use IBM Plex Sans as default font family, using the regular and bold styles from it.
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
No description provided.