| 1 | # Form Design System
|
| 2 |
|
| 3 | A design system by CB Insights.
|
| 4 |
|
| 5 | [](http://www.npmjs.com/package/@cbinsights/fds)
|
| 6 | [](https://codecov.io/gh/cbinsights/form-design-system)
|
| 7 | [](https://github.com/semantic-release/semantic-release)
|
| 8 | [](https://github.com/cbinsights/form-design-system/issues)
|
| 9 |
|
| 10 | ### Installation
|
| 11 |
|
| 12 | ```bash
|
| 13 | yarn add @cbinsights/fds
|
| 14 | ```
|
| 15 |
|
| 16 | ### Install SDKs
|
| 17 |
|
| 18 | First time clone of this repo will show you errors on types and it will say it cannot find imported libraries, to fix this you need to install SDKs, to do so, run the following command:
|
| 19 |
|
| 20 | ```
|
| 21 | yarn dlx @yarnpkg/sdks vscode
|
| 22 | ```
|
| 23 |
|
| 24 | ---
|
| 25 |
|
| 26 | ### Docs
|
| 27 |
|
| 28 | https://cbinsights.github.io/form-design-system/
|
| 29 |
|
| 30 | ## Want to contribute?
|
| 31 |
|
| 32 | - Fork the repo
|
| 33 | - Run `yarn install`
|
| 34 | - Use `yarn commit` to help you generate a [conventional commit](https://www.conventionalcommits.org/)
|
| 35 | - Ideally reference a issue number in the commit body (e.g. fixes #123). `yarn commit` will help you with this.
|
| 36 | - Make a pull request!
|