Skip to content

Commit

Permalink
docs(readme): update contributing instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
estevanmaito committed Nov 8, 2020
1 parent eb0d2cd commit c7d683e
Showing 1 changed file with 2 additions and 24 deletions.
26 changes: 2 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,36 +68,14 @@ function App() {
export default App
```

## 🗺 Roadmap

- [ ] Development live server (currently using Styleguidist; polutes the `src` directory)

Things that are not in the plans for the near future and why:

#### New components

This library is so fresh, that if we just add new components now, we'll be just introducing bugs and bad design decisions into more code.

So, until we get to a point that the current components are in good shape and we have a clear vision of what a good component must have, we will just work on the existing component base.

How long will it take? A week, a month, it depends on the time I can put into it.

## 🔌 Contributing

- Fork
- Clone
- `npm install`
- `npm run dev`

It will start a local server at `localhost:6060` with all components rendered.

> This needs improvement. I'm looking for a better way to create a local dev server.
- `npm run storybook`

To see a new component rendered, add an `.md` file with the same name as the component (see current components), and add components inside like:

```js
<Button size="larger">Larger</Button>
```
It will start a local server at `localhost:6006` with all components rendered.

⚠ Use `npm run cz` instead of `git commit`! It will guide you through some short questions and guarantee that you commit message is standardized.

Expand Down

0 comments on commit c7d683e

Please sign in to comment.