Browse Source

Change contribution document

杜府 3 years ago
parent
commit
3ed1db7c9c
2 changed files with 3 additions and 11 deletions
  1. 1 5
      doc/guide/contribution.md
  2. 2 6
      doc/guide/contribution_en.md

+ 1 - 5
doc/guide/contribution.md

@@ -15,11 +15,7 @@
 
 调试 STDF 必须要有个工程环境,为此提供了一个简单的 Demo 工程。STDF 本身不受 Node 版本限制,Demo 使用 Vite 开发,所以请确保你的 Node.js 版本 >= 14.18+,参考 [Vite 官网](https://cn.vitejs.dev/guide/#scaffolding-your-first-vite-project)。
 
-> 推荐使用 [pnpm](https://pnpm.io/zh) 进行包管理。
-
-> 推荐安装针对 Svelte 的 [VSCode 插件](https://marketplace.visualstudio.com/items?itemName=svelte.svelte-vscode) 或者 [WebStorm 插件](https://plugins.jetbrains.com/plugin/12375-svelte) 进行开发。
-
-> 推荐安装针对 Tailwind 的 [VSCode 插件](https://marketplace.visualstudio.com/items?itemName=bradlc.vscode-tailwindcss)。WebStorm 默认集成,[了解更多](https://www.jetbrains.com/help/webstorm/tailwind-css.html)。
+> 推荐:使用 [pnpm](https://pnpm.io/zh) 进行包管理;安装针对 Svelte 的 [VSCode 插件](https://marketplace.visualstudio.com/items?itemName=svelte.svelte-vscode) 或者 [WebStorm 插件](https://plugins.jetbrains.com/plugin/12375-svelte) 进行开发;安装针对 Tailwind 的 [VSCode 插件](https://marketplace.visualstudio.com/items?itemName=bradlc.vscode-tailwindcss),WebStorm 默认集成,[了解更多](https://www.jetbrains.com/help/webstorm/tailwind-css.html)。
 
 按照下面的步骤操作,即可在本地快速启动 STDF Demo。
 

+ 2 - 6
doc/guide/contribution_en.md

@@ -11,15 +11,11 @@ Below are guidelines for submitting feedback or code to STDF. Before submitting
 
 ## Local Development
 
-Before local development, make sure that Git and Node.js are installed in your development environment.
+22Before local development, make sure that Git and Node.js are installed in your development environment.
 
 Debugging of STDF requires a project environment. Therefore, we provide a simple Demo project. The version of Node.js used by STDF is not limited; however, Vite is used for developing Demo projects. Therefore, ensure that your Node.js version >= 14.18+ (refer to [Vite official website](https://vitejs.dev/guide/#scaffolding-your-first-vite-project)).
 
-> It is recommended to use [pnpm](https://pnpm.io) for package management.
->
-> It is recommended to install [VSCode plugin](https://marketplace.visualstudio.com/items?itemName=svelte.svelte-vscode) or [WebStorm plugin](https://plugins.jetbrains.com/plugin/12375-svelte) specifically designed for Svelte development.
->
-> It is recommended to install [VSCode plugin](https://marketplace.visualstudio.com/items?itemName=bradlc.vscode-tailwindcss) specifically designed for Tailwind CSS. WebStorm integrates it by default ([learn more here](https://www.jetbrains.com/help/webstorm/tailwind-css.html)).
+> Recommended: Use [pnpm](https://pnpm.io) for package management. Install [VSCode plugin](https://marketplace.visualstudio.com/items?itemName=svelte.svelte-vscode) or [WebStorm plugin](https://plugins.jetbrains.com/plugin/12375-svelte) specifically designed for Svelte development. Install [VSCode plugin](https://marketplace.visualstudio.com/items?itemName=bradlc.vscode-tailwindcss) specifically designed for Tailwind CSS. WebStorm integrates it by default ([learn more here](https://www.jetbrains.com/help/webstorm/tailwind-css.html)).
 
 Follow these steps below to quickly start up STDF Demo locally: