# 贡献指南 > **欢迎贡献！** 感谢您对 PostWaver 项目的关注。 --- ## 📋 目录 - [行为准则](#行为准则) - [如何贡献](#如何贡献) - [开发流程](#开发流程) - [代码规范](#代码规范) - [提交规范](#提交规范) - [Pull Request 流程](#pull-request-流程) --- ## 🤝 行为准则 - 尊重所有贡献者 - 使用友好和包容的语言 - 接受建设性批评 - 关注对社区最有利的事情 --- ## 🚀 如何贡献 ### 报告 Bug 1. 检查 [Issues](https://github.com/Charliechen114514/post_waver/issues) 确认问题未被报告 2. 创建新 Issue，包含： - 清晰的标题 - 详细的问题描述 - 复现步骤 - 预期行为 vs 实际行为 - 环境信息（操作系统、Node.js 版本等） - 相关日志或截图 ### 提出新功能 1. 先在 [Issues](https://github.com/Charliechen114514/post_waver/issues) 讨论 2. 说明： - 功能的用例 - 为什么这个功能很重要 - 可能的实现方式 - 是否愿意贡献代码 ### 贡献代码 #### 小改动 - 修复错别字 - 修复小 bug - 改进文档 - 添加注释直接提交 Pull Request 即可。 #### 大改动 1. 先在 Issues 中讨论 2. 等待维护者确认 3. 开发前确认需求和实现方案 4. 遵循开发流程 --- ## 🔧 开发流程 ### 环境搭建 ```bash # 1. Fork 仓库 # 点击 GitHub 页面的 "Fork" 按钮 # 2. Clone 你的 fork git clone https://github.com/YOUR_USERNAME/post_waver.git cd post_waver # 3. 安装依赖 pnpm install # 4. 构建项目 pnpm build # 5. 启动开发服务器 pnpm start ``` ### 分支策略 - `main` - 主分支，保持稳定 - `feature/*` - 新功能开发 - `fix/*` - Bug 修复 - `docs/*` - 文档更新 - `refactor/*` - 代码重构 ### 开发步骤 ```bash # 1. 更新主分支 git checkout main git pull upstream main # 2. 创建新分支 git checkout -b feature/your-feature-name # 3. 进行开发 # ... 编写代码 ... # 4. 运行测试 pnpm test pnpm typecheck pnpm lint # 5. 提交代码 git add . git commit -m "feat: add your feature description" # 6. 推送到你的 fork git push origin feature/your-feature-name # 7. 创建 Pull Request # 在 GitHub 上打开 Pull Request ``` --- ## 📐 代码规范 ### TypeScript - 使用 TypeScript 进行类型检查 - 避免使用 `any` 类型 - 导出的函数必须有类型签名 - 使用接口定义数据结构 ### 命名规范 - **文件名**: 使用 kebab-case（如：`image-resolver.ts`） - **变量名**: 使用 camelCase（如：`userName`） - **常量名**: 使用 UPPER_SNAKE_CASE（如：`MAX_COUNT`） - **类名**: 使用 PascalCase（如：`UserService`） - **接口名**: 使用 PascalCase，无前缀（如：`User`） ### 代码风格 ```typescript // ✅ 好的实践 export async function parseMarkdown(content: string): Promise { try { const result = await processor.process(content); return result; } catch (error) { throw new Error(`Failed to parse markdown: ${error.message}`); } } // ❌ 不好的实践 export async function parse(c: any) { return await processor.process(c); } ``` ### 注释规范 ```typescript /** * 解析 Markdown 内容 * * @param content - Markdown 内容 * @returns 解析后的内容对象 * @throws {Error} 当解析失败时抛出错误 * * @example * ```typescript * const result = await parseMarkdown("# Hello"); * console.log(result.title); // "Hello" * ``` */ export async function parseMarkdown(content: string): Promise { // ... } ``` --- ## 📝 提交规范 ### 提交消息格式使用 [Conventional Commits](https://www.conventionalcommits.org/) 规范： ``` ():