Skip to content

Commit

Permalink
docs: fix minor spelling/grammar issues
Browse files Browse the repository at this point in the history
  • Loading branch information
chasinhues authored Aug 31, 2020
1 parent 65593d6 commit fb52a3f
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,28 +67,28 @@ use consumed independently.
cross-component development and builds all components.

**`yarn bootstrap`**: bootstraps the entire project and symlinks all
dependencies for cross-component development
dependencies for cross-component development.

**`yarn storybook`**: starts storybook server and loads stories in files that
ends with `.stories.tsx`
end with `.stories.tsx`.

**`yarn docs:start`**: run the documentation site locally
**`yarn docs:start`**: run the documentation site locally.

**`yarn build`**: run build for all component packages
**`yarn build`**: run build for all component packages.

**`yarn test`**: run test for all component packages
**`yarn test`**: run test for all component packages.

**`yarn release`**: publish changed packages
**`yarn release`**: publish changed packages.

**`yarn [package] <cmd>`**: Run a command on the specific package you're working
on. You can run `build`, `test`, `lint` commands
on. You can run `build`, `test`, `lint` commands.

#### Package Aliasing and Yarn Workspace

Since we're using lerna monorepo + yarn workspaces by default, this enables us
to run commands within component package directly from the root.
to run commands within component packages directly from the root.

Each component is named this way `@chakra-ui/[component]`. Let's say we want to
Each component is named this way: `@chakra-ui/[component]`. Let's say we want to
build the checkbox component. Here's how to do it:

```bash
Expand All @@ -100,7 +100,7 @@ lerna run build --scope @chakra-ui/button
```

**Shortcut:** To make this shorter and more convenient, we've added an alias for
each component in the root `package.json`. Now you can simple do:
each component in the root `package.json`. Now you can simply do:

```bash
# to build
Expand Down Expand Up @@ -130,7 +130,7 @@ Build components in isolation with Storybook using `yarn storybook`.
## Think you found a bug?

Please conform to the issue template and provide a clear path to reproduction
with a code example. The best way to show a bug is by sending a CodeSandbox link
with a code example. The best way to show a bug is by sending a CodeSandbox link.

You may wish to use our starters to help you get going:

Expand All @@ -140,7 +140,7 @@ You may wish to use our starters to help you get going:
## Proposing new or changed API?

Please provide thoughtful comments and some sample API code. Proposals that
don't line up with our roadmap or doesn't have a thoughtful explanation will be
don't line up with our roadmap or don't have a thoughtful explanation will be
closed.

## Making a Pull Request?
Expand Down

0 comments on commit fb52a3f

Please sign in to comment.