🙌 PostBot 开源项目贡献指南

感谢您对本项目的兴趣！我们欢迎任何形式的贡献，包括报告问题、提交修复代码、提交新功能等。为了确保项目的健康发展，请在开始贡献之前，阅读并遵循以下指南。

如何开始

克隆项目到本地，使用以下命令：

bash

git clone https://github.com/gitcoffee-os/postbot.git

安装依赖
根据项目的需求安装所需的依赖。通常，你可以在项目的 README 文件中找到相关安装说明。
创建新分支
请确保在开始工作之前，从 main 或 master 分支拉取最新的代码，并为你要修复的问题或功能创建一个新的分支：
bash
```
git checkout -b <功能分支名称>
```

报告问题

如果你发现了问题或有建议，请通过以下步骤报告问题：

在 GitHub 上的 Issues 页签中创建一个新的问题。
详细描述问题，并附上重现步骤、错误信息、截图等可能帮助解决问题的信息。

提交代码

分支管理

在进行任何更改时，请始终确保你从最新的 main 或 master 分支创建一个新的分支，并将工作提交到该分支。

提交消息规范

我们遵循 Conventional Commits 规范进行提交消息格式化。确保每次提交时消息简洁明了，遵循以下格式：

<类型>(<范围>): <描述>

例如：

feat(auth): 添加用户登录功能
fix(ui): 修复按钮点击无响应问题
docs: 更新文档中的 API 使用示例

常见类型：

feat: 新增功能
fix: 修复 bug
docs: 仅文档修改
style: 代码格式（不影响功能的修改）
refactor: 重构代码
test: 添加或修改测试代码
chore: 其他杂项（例如构建过程或依赖管理）

代码风格

本项目使用 Prettier 和 ESLint 来规范代码风格。请在提交代码之前，确保代码已经经过自动格式化和静态检查。如果没有安装相关工具，请参考以下步骤：

安装依赖：
bash
```
pnpm i
```

运行代码格式化：

bash

pnpm run lint -- --fix
pnpm run prettier -- --write

测试

我们鼓励编写测试以确保代码质量和防止回归。在提交代码之前，请确保所有测试通过。

添加测试
如果你的更改涉及到功能或 bug 修复，请为该部分添加新的单元测试，并确保测试覆盖所有相关场景。
运行测试
运行项目的测试套件，确保所有测试都能顺利通过。
bash
```
pnpm test
```

代码审查

每个提交都会通过 Pull Request (PR) 提交审查。我们欢迎任何人参与审查工作。审查时，请遵循以下几点：

检查代码的功能：确保代码解决了问题或实现了预期的功能。
检查代码质量：确保代码易于阅读和理解，遵循项目的编码标准。
检查测试覆盖率：确保功能的变化没有导致测试的失败，必要时编写新的测试。

许可协议

本项目遵循 Apache License 2.0 许可证，详细内容请参见 LICENSE 文件。

感谢你为本项目的贡献！如果你有任何问题或建议，请随时提出，我们会尽力帮助你。

🙌 PostBot 开源项目贡献指南 ​

目录 ​

如何开始 ​

报告问题 ​

提交代码 ​

分支管理 ​

提交消息规范 ​

代码风格 ​

测试 ​

代码审查 ​

许可协议 ​