feat(ko): add cn readme and Contributing

Author: shuangxu

CONTRIBUTING.md

@@ -1,8 +1,3 @@
----
-sidebar_position: 6
-title: Contributing
----
-
 # Contributing to ko
 
 We use **pnpm workspace** to manage our packages. so make sure you use **pnpm** as package manager than **npm** or **yarn**.
@@ -15,7 +10,7 @@ pnpm install
 
 ## Code Structure
 
-as a **monorepo**, ko now maintain 4 packages in packages directory:
+as a **monorepo**, ko now maintain 5 packages in packages directory:
 
 * **ko**: main package
 * **ko-lints**: code format cli, include **eslint**, **prettier** and **stylelint**, can be integrated in ko or use individually

CONTRIBUTING_CN.md

@@ -0,0 +1,57 @@
+# 贡献到 ko
+
+We use **pnpm workspace** to manage our packages. so make sure you use **pnpm** as package manager than **npm** or **yarn**.
+我们使用 **pnpm workspace** 来管理我们的包，请确保您使用 **pnpm** 作为包管理器，而不是 **npm** 或 **yarn**。
+
+在使用此仓库之前:
+``` bash
+pnpm install
+```
+
+## 代码结构
+
+作为一个 monorepo，ko 现在在 packages 目录中维护了 5 个包:
+
+* **ko**: 主要包
+* **ko-lints**: 代码格式化 cli, 包 **eslint**, **prettier** 和 **stylelint**, 可以集成到 ko 中或单独使用
+* **ko-config**: **ko-lints** 使用的默认配置
+* **ko-lint-config**: 代码格式化配置，包括 **eslint**, **prettier** 和 **stylelint**
+* **babel-preset-ko-app**: ko 使用的 babel 预设
+
+### 调试
+
+使用 `pnpm debug` 调试本地包
+
+### 本地测试
+
+使用 **pnpm link** 将 `ko` 链接到本地包中进行测试
+
+## 提交 Pull Request (PR)
+
+在提交 Pull Request (PR) 之前，请考虑以下准则:
+- 在存储库的根目录中运行 `pnpm changeset`，并描述您的更改。生成的文件应该被提交，因为它们将在发布时使用。
+- 运行完整的测试套件，并确保所有测试都通过。
+- 推送您的分支到 GitHub:
+
+  ```shell
+  git push origin my-fix-branch
+  ```
+
+- 在 GitHub 上发送一个 pull request。
+- 如果我们建议更改，则:
+
+  - Make the required updates.
+  - Re-run the test suites to ensure tests are still passing.
+  - Rebase your branch and force push to your GitHub repository (this will update your Pull Request):
+  - 进行所需的更新。
+
+  - 重新运行测试套件，以确保测试仍然通过。
+
+  - 将您的分支 rebase 并强制推送到您的 GitHub 存储库（这将更新您的 Pull Request）：
+
+    ```shell
+    git rebase main -i
+    git push -f
+    ```
+
+感谢您的贡献！

README.md

@@ -1,13 +1,14 @@
 # ko
+English | [简体中文](./README_CN.md)
 
-## Simple, yet powerful, tool for managing your react applications. 
+## Simple, yet powerful, tool for managing your react applications.
 
 <a href="https://www.npmjs.com/package/ko"><img alt="NPM Status" src="https://img.shields.io/npm/v/ko.svg?style=flat"></a>
 
 ## Features
 
 * Support building applications on top of **webpack v5** and **esbuild**
-* Customize ko to work exactly the way you need it for your applications 
+* Customize ko to work exactly the way you need it for your applications
 * Built-in popular linting tools to lint your source code
 * Built-in support typescript
 
@@ -18,18 +19,18 @@ You can install ko using npm, yarn or pnpm:
 npm install ko --save-dev
 # or
 yarn add ko --dev
-# or 
+# or
 pnpm add ko --save-dev
 ```
 
 ## Documents
-* [Introduction](https://dtstack.github.io/ko/docs/current/introduction)
-* [Getting Started](https://dtstack.github.io/ko/docs/current/getting-started)
-* [FAQ](https://dtstack.github.io/ko/docs/current/FAQ)
+* [Introduction](https://dtstack.github.io/ko/zh-CN/docs/current/introduction)
+* [Getting Started](https://dtstack.github.io/ko/zh-CN/docs/current/getting-started)
+* [FAQ](https://dtstack.github.io/ko/zh-CN/docs/current/FAQ)
 
 ## Contributing
 
-We'd love to have your helping hand on `ko`! See [CONTRIBUTING](https://github.com/DTStack/ko/blob/master/CONTRIBUTING.md) for more information on how to get started.
+We'd love to have your helping hand on `ko`! See [CONTRIBUTING](./CONTRIBUTING.md) for more information on how to get started.
 
 ## License
 

README_CN.md

@@ -0,0 +1,38 @@
+# ko
+
+## 一个简单而强大的工具，用于管理您的 React 应用程序。
+
+<a href="https://www.npmjs.com/package/ko"><img alt="NPM Status" src="https://img.shields.io/npm/v/ko.svg?style=flat"></a>
+
+## 特点
+
+* 支持在 **webpack v5** 和 **esbuild** 上构建应用程序
+* 定制 ko，使其完全按照您的应用程序需求工作
+* 内置流行的 lint 工具，用于对源代码进行 lint
+* 内置支持 TypeScript
+
+## 安装
+
+您可以使用 npm、yarn 或 pnpm 安装 ko：
+``` bash
+npm install ko --save-dev
+# 或者
+yarn add ko --dev
+# 或者
+pnpm add ko --save-dev
+```
+
+## 文档
+* [介绍](https://dtstack.github.io/ko/docs/current/introduction)
+* [入门指南](https://dtstack.github.io/ko/docs/current/getting-started)
+* [常见问题](https://dtstack.github.io/ko/docs/current/FAQ)
+
+## Contributing
+
+我们很乐意在 `ko` 上得到您的帮助！有关如何入手的更多信息，请参见 [CONTRIBUTING](./CONTRIBUTING_CN.md)。
+
+## License
+
+版权所有 © DTStack。保留所有权利。
+
+根据 MIT 许可证获得许可。

packages/ko/README.md

@@ -1,5 +1,5 @@
 # ko
-
+English | [简体中文](./README_CN.md)
 ## Simple, yet powerful, tool for managing your react applications. 
 
 <a href="https://www.npmjs.com/package/ko"><img alt="NPM Status" src="https://img.shields.io/npm/v/ko.svg?style=flat"></a>
@@ -23,13 +23,13 @@ pnpm add ko --save-dev
 ```
 
 ## Documents
-* [Introduction](https://dtstack.github.io/ko/docs/introduction)
-* [Getting Started](https://dtstack.github.io/ko/docs/getting-started)
-* [FAQ](https://dtstack.github.io/ko/docs/FAQ)
+* [Introduction](https://dtstack.github.io/ko/zh-CN/docs/current/introduction)
+* [Getting Started](https://dtstack.github.io/ko/zh-CN/docs/current/getting-started)
+* [FAQ](https://dtstack.github.io/ko/zh-CN/docs/current/FAQ)
 
 ## Contributing
 
-We'd love to have your helping hand on `ko`! See [CONTRIBUTING](https://dtstack.github.io/ko/docs/contributing/) for more information on how to get started.
+We'd love to have your helping hand on `ko`! See [CONTRIBUTING](../../CONTRIBUTING.md) for more information on how to get started.
 
 ## License
 

packages/ko/README_CN.md

@@ -0,0 +1,38 @@
+# ko
+
+## 一个简单而强大的工具，用于管理您的 React 应用程序。
+
+<a href="https://www.npmjs.com/package/ko"><img alt="NPM Status" src="https://img.shields.io/npm/v/ko.svg?style=flat"></a>
+
+## 特点
+
+* 支持在 **webpack v5** 和 **esbuild** 上构建应用程序
+* 定制 ko，使其完全按照您的应用程序需求工作
+* 内置流行的 lint 工具，用于对源代码进行 lint
+* 内置支持 TypeScript
+
+## 安装
+
+您可以使用 npm、yarn 或 pnpm 安装 ko：
+``` bash
+npm install ko --save-dev
+# 或者
+yarn add ko --dev
+# 或者
+pnpm add ko --save-dev
+```
+
+## 文档
+* [介绍](https://dtstack.github.io/ko/docs/current/introduction)
+* [入门指南](https://dtstack.github.io/ko/docs/current/getting-started)
+* [常见问题](https://dtstack.github.io/ko/docs/current/FAQ)
+
+## Contributing
+
+我们很乐意在 `ko` 上得到您的帮助！有关如何入手的更多信息，请参见 [CONTRIBUTING](../../CONTRIBUTING_CN.md)。
+
+## License
+
+版权所有 © DTStack。保留所有权利。
+
+根据 MIT 许可证获得许可。