docs: add CONTRIBUTING.md (#84)

Co-authored-by: jpsong <[email protected]>

Author: yes1am

CONTRIBUTING.md

@@ -0,0 +1,74 @@
+我们推荐使用 [pnpm](https://github.com/pnpm/pnpm) 作为包管理工具
+
+## 1. 下载项目、安装依赖
+
+```shell
+git [email protected]:open-jike/jike-sdk.git
+cd jike-sdk
+pnpm install
+```
+
+## 2. 创建本地开发文件
+
+- 新建 `playground/main.ts` 文件
+- 编写代码，例如:
+
+```ts
+import { api, setApiConfig } from '../src'
+
+setApiConfig({
+  endpointId: 'jike',
+  endpointUrl: '<jike-endpoint-url>', // 请自行替换
+  bundleId: '<bundle-id>', // 请自行替换
+  buildNo: '<build-no>', // 请自行替换
+  userAgent: '<jike-sdk-user-agent>', // 请自行替换
+  accessToken: '<access-token>', // 请自行替换
+  appVersion: '<app-version>', // 请自行替换
+  deviceId: '<device-id>', // 请自行替换
+})
+
+api.topic
+  .getTabsSquareFeed('562dfeb0daf87d13002cad92', {
+    limit: 10,
+  })
+  .then((res) => {
+    console.log('请求成功', res.data.data)
+  })
+  .catch((err) => {
+    console.log('请求错误', err)
+  })
+```
+
+## 3. 运行本地开发文件
+
+```shell
+pnpm run dev
+```
+
+## 4. 测试
+
+1. 新建 `tests/config.ts` 配置文件, 内容如下:
+
+```ts
+export const config = {
+  endpointId: 'jike',
+  endpointUrl: '<jike-endpoint-url>', // 请自行替换
+  bundleId: '<bundle-id>', // 请自行替换
+  buildNo: '<build-no>', // 请自行替换
+  userAgent: '<jike-sdk-user-agent>', // 请自行替换
+  accessToken: '<access-token>', // 请自行替换
+  appVersion: '<app-version>', // 请自行替换
+  deviceId: '<device-id>', // 请自行替换
+}
+```
+
+2. 新建测试文件, 如 `tests/api/topic.test.ts`, 编写测试代码
+
+3. 执行测试用例
+
+```shell
+pnpm run test
+
+# 测试指定的测试文件, 如只测试新增的 topic.test.ts
+pnpm run test topic
+```

README.md

@@ -151,6 +151,10 @@ const client = ApiClient(apiConfig)
 client.users.profile()
 ```
 
+## Contributing [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://makeapullrequest.com)
+
+see [CONTRIBUTING.md](./CONTRIBUTING.md)
+
 ## Sponsors
 
 <p align="center">