欢迎参与贡献，提 PR ​

贡献指南 ​

可在 github 页 fork 一份仓库代码，然后基于 fork 后的提 PR 过来。

推荐使用 pnpm 安装：

pnpm install

本地环境开发：

pnpm dev

文章贡献 ​

对于文章贡献，分两种情况：

• 如果你是原创作者，请在 author 字段填写自己的 GitHub 账号名，会自动在文章末尾进行声明。

• 如果你是修正某篇文章，请在 contributors 字段增加自己的 GitHub 账号名，也会有贡献者头像，并不会修改原作者信息。

---
author: Vincent Wang
contributors: [HearLing]
---

代码格式 ​

对于代码格式，本仓库使用 prettier 与 git-hooks，在你提交代码的时候会进行格式化以及修复一些问题。

也可以手动执行一下：

pnpm prettier:fix

提交之前需要build检查有没有错误。

pnpm run build && pnpm run serve

重建所有的index.md文件

pnpm run build:index

贡献者列表 ​

推荐大家自行填写相关信息，只需要在 docs/index.md 文件内添加自己的相关信息即可，无需修改 contributors.json 文件，该文件会自动生成。

文字排版 ​

笔记内容按照 中文文案排版指北进行排版，即尽量保证中英文之间的空格，也可以使用 VSCode 相关格式化工具。

md的文档格使用pritter配合vscode的插件esbenp.prettier-vscode

感谢参与 ​

非常感谢你对于 ChoDocs 的参与贡献，我们会在首页 chodocs.cn 展示各位贡献者的头像！