Merge pull request #2 from Amy0104/feature/docs
[Doc] Add README.md and CONTRIBUTING.md
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..83a9794
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,52 @@
+# Contributing to the DolphinScheduler Studio
+
+Thanks for taking the time to contribute !
+You can start by reading this guidelines.
+
+## Setup
+
+Install the dependencies
+
+```shell
+pnpm install
+pnpm dev
+```
+
+Please don't forget to setup your IDE with `eslint` and `prettier`.
+
+## Project structure
+
+- **studio** contains studio component.
+ - **component** contains generic components used inside the studio component.
+ - **hooks** contains generic hooks.
+ - **locales** contains locales.
+ - **pages** contains page components for vue-router.
+ - **service** contains axios initialization and apis
+
+- **src** contains a separate project that references studio.
+ - **assets** contains generic assets used inside the separate project.
+ - **component** contains generic components.
+ - **locales** contains vue-il8n initialization and locales.
+ - **router** contains vue-router initialization and routers.
+ - **views** contains page components for vue-router.
+
+## Issue reports
+
+A bug is a _demonstrable problem_ that is caused by the code in the repository.
+Good bug reports are extremely helpful - thank you!
+
+Guidelines for bug reports:
+
+1. **Use the GitHub issue search** — check if the issue has already been
+ reported.
+
+2. **Check if the issue has been fixed** — try to reproduce it using the
+ latest `main` branch in the repository.
+
+3. **Add attachments** — add photos or gifs.
+
+A good bug report shouldn't leave others needing to chase you up for more
+information. Please try to be as detailed as possible in your report. What is
+your environment? What steps will reproduce the issue? What browser(s) and OS
+experience the problem? What would you expect to be the outcome? All these
+details will help people to fix any potential bugs.
\ No newline at end of file
diff --git a/README.md b/README.md
index 4fe950e..7cf4d2c 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,27 @@
# DolphinScheduler Studio
[](https://www.apache.org/licenses/LICENSE-2.0.html)
+
+DolphinScheduler Studio is a debugging platfrom for [DolphinScheduler](https://github.com/apache/dolphinscheduler).
+
+If you want to contribute, please refer to the [contributing guidelines](./CONTRIBUTING.md) of this project.
+
+
+## Quick start
+
+install dependencies using **pnpm**
+
+```shell
+pnpm install
+```
+start the development server
+
+```shell
+pnpm dev
+```
+
+build a studio component
+
+```shell
+pnpm build
+```
\ No newline at end of file
