贡献指南

我们热烈欢迎各位的贡献，并会给予充分的认可。在您提交贡献之前，这里有一些注意事项：

😄 贡献示例

• 作为 bug 报告的失败回归测试。
• 文档改进，例如修正拼写错误、添加章节。
• 为现有扩展添加新功能，例如新增可配置选项。
• 对核心部分进行解释清晰且不会造成破坏的更改。

🛠️ 搭建开发环境

前提条件

您需要先安装以下工具：

• Git
• Node
• yarn
• git-cz

# 安装 yarn
sudo npm install -g yarn

# 安装 git-cz
sudo npm install -g git-cz

复刻并克隆仓库到本地

git clone git@github.com:yourname/pileax.git

🧑🏻‍💻 开发与提交

创建新特性分支

git checkout -b feat/new-feature

代码修改

针对新特性进行具体的代码修改。

代码检查、测试和构建

代码检查

yarn lint

确保没有代码检查问题，若有问题可使用以下命令修复：

yarn lint-fix
yarn format

构建

yarn build
yarn build:electron

预览

yarn preview

您可以访问 http://127.0.0.1:9601 检查您的更改是否符合预期。

提交代码

现在可以安全地提交代码了。

git add .
git cz

🚀 发起拉取请求

推送分支

git push origin feat/new-feature

创建拉取请求

我们建议使用模板创建拉取请求：

gh pr create --title "feat: new feature" --body-file .github/pull_request_template.md

或者在 GitHub 上创建 拉取请求。

📃 文档

文档和代码同样重要。请在代码进行任何更改时，同步更新相应的文档仓库。

• 代码仓库：在此修改代码。
• 文档仓库：在此更新或添加文档，以反映在 Yiitap 仓库中所做的更改。