🙌 Postar 开源贡献指南

感谢您对本项目的关注！我们欢迎所有形式的贡献，包括报告问题、提交错误修复、提出新功能等。为确保项目的健康发展，请在贡献前阅读并遵循以下指南。

开始

克隆项目到本地：

bash

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

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

报告问题

如果您发现问题或有建议，请按照以下步骤报告：

在 GitHub 的 Issues 页面创建新的 issue。
详细描述问题，包括复现步骤、错误信息、截图以及任何可能有助于解决问题的信息。

提交代码

分支管理

进行任何更改时，始终从最新的 main 或 master 分支创建新分支，并将您的工作提交到该分支。

提交信息规范

我们遵循 Conventional Commits 规范来格式化提交信息。确保每条提交信息简洁明了，并遵循以下格式：

<type>(<scope>): <description>

示例：

feat(publisher): 添加 Medium 平台发布支持
fix(content): 修复内容提取时图片丢失的问题
docs: 更新文档中的 API 使用示例

常见类型：

feat：新功能
fix：错误修复
docs：仅文档
style：代码格式化（无功能变更）
refactor：代码重构
test：添加或更新测试
chore：杂项（如构建过程或依赖管理）

代码风格

本项目使用 Prettier 和 ESLint 来强制执行代码风格。在提交代码之前，确保代码已经自动格式化并通过静态检查。如果您没有安装这些工具，请按照以下步骤操作：

安装依赖：
bash
```
pnpm i
```
运行代码格式化：
bash
```
pnpm run format
pnpm run format:check
```

测试

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

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

代码审查

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

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

许可证

本项目基于 Apache License 2.0 许可。详见 LICENSE 文件。

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

🙌 Postar 开源贡献指南 ​

目录 ​

开始 ​

报告问题 ​

提交代码 ​

分支管理 ​

提交信息规范 ​

代码风格 ​

测试 ​

代码审查 ​

许可证 ​