[skip-ci] docs: added contributing guide

CONTRIBUTE.md

@@ -0,0 +1,26 @@
+# Contributing Guide
+
+Hi! We are really excited that you are interested in contributing to our Design System. Before submitting your contribution, please make sure to take a moment and read through the following guide:
+
+## Repo Setup
+
+This repo is monorepo using yarn 2 workspace. The package manager used to install and link dependencies must be [yarn][yarn].
+
+To develop, and test:
+
+1. Run `yarn install`
+2. Run `yarn dev` to start development server
+3. Run `yarn test` to run unit test
+
+## Creating Components
+
+- Creating should be place in `components/` directory and grouped with their directory. The Component at least has 3 files:
+  - `[Component].vue` - The component SFC itself <sup>*</sup>
+  - `[Component].spec.ts` - The component unit test <sup>*</sup>
+  - `component.md` - The component documentation
+
+      <small>*: Change `[Component]` to your actual Component name</small>
+
+- To shown in sidebar, you need register your component into vitepress config `./components/.vitepress/config.ts`
+
+[yarn]: https://yarnpkg.com/getting-started

README.md

@@ -1,7 +1,19 @@
-# design-system
+# @privyid/design-system
 
 [![Build CI](https://github.com/privy-open-source/design-system/actions/workflows/node.js.yml/badge.svg)](https://github.com/privy-open-source/design-system/actions/workflows/node.js.yml)
 [![CodeQL](https://github.com/privy-open-source/design-system/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/privy-open-source/design-system/actions/workflows/codeql-analysis.yml)
 [![codecov](https://codecov.io/gh/privy-open-source/design-system/branch/main/graph/badge.svg?token=8X8YYDP2SI)](https://codecov.io/gh/privy-open-source/design-system)
+[![codiga](https://api.codiga.io/project/32578/status/svg)](https://app.codiga.io/public/project/32578/design-system/dashboard)
 
 > PrivyID Design System
+
+## Installation
+
+TODO
+
+## Contribution
+See [Contributing Guide](/CONTRIBUTE.md)
+
+## License
+
+[MIT](/LICENSE) License (c) 2022 Privy Identitas Digital