Skip to content
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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Update README.md #746

wants to merge 3 commits into from

Conversation

laiseing
Copy link
Contributor

@laiseing laiseing commented Apr 6, 2022

No description provided.

@lucasjoao lucasjoao self-assigned this Apr 6, 2022
@codecov
Copy link

codecov bot commented Apr 6, 2022

Codecov Report

Merging #746 (c25e3ee) into main (93985db) will not change coverage.
The diff coverage is n/a.

@@           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

@lucasjoao lucasjoao mentioned this pull request Apr 6, 2022
Copy link
Contributor

@lucasjoao lucasjoao left a 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
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
> #### 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.

@lucasjoao lucasjoao removed their assignment Apr 6, 2022
Copy link
Contributor

@gustavomoser gustavomoser left a 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
Copy link
Contributor

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?

Copy link
Contributor

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
Copy link
Contributor

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.

@vercel
Copy link

vercel bot commented Jan 6, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
bold 🔄 Building (Inspect) Jan 6, 2023 at 2:52PM (UTC)

@vercel vercel bot temporarily deployed to Preview January 6, 2023 14:54 Inactive
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.

3 participants