贡献指南

🤝 贡献指南

欢迎对 SearchFly 进行贡献！请按照以下步骤进行：

贡献流程

1. Fork 本仓库
2. 创建功能分支：git checkout -b feature/your-feature
3. 提交更改：git commit -m 'Add some feature'
4. 推送到分支：git push origin feature/your-feature
5. 提交 Pull Request

开发规范

代码风格

• 遵循 Prettier 配置进行代码格式化
• 使用 TypeScript 进行开发，确保类型安全
• 代码结构清晰，注释完整

提交信息规范

使用语义化提交规范，提交信息格式：

<type>: <description>

<optional body>

<optional footer>

类型说明：

• feat: 新增功能
• fix: 修复 bug
• docs: 文档更新
• style: 代码格式调整
• refactor: 代码重构
• perf: 性能优化
• test: 测试相关
• chore: 构建过程或辅助工具的变动

分支管理

• main: 主分支，包含稳定版本的代码
• dev: 开发分支，包含最新的开发代码
• feature/*: 功能分支，用于开发新功能
• fix/*: 修复分支，用于修复 bug

开发环境搭建

1. 克隆仓库：git clone https://github.com/gitcoffee-os/searchfly.git
2. 安装依赖：pnpm i
3. 启动开发服务器：pnpm dev
4. 开始开发

测试

• 确保所有功能正常工作
• 运行代码质量检查：pnpm format:check
• 测试扩展在不同浏览器中的兼容性

文档贡献

• 更新 README.md 和其他文档
• 确保文档内容与代码一致
• 遵循 Markdown 格式规范

行为准则

• 尊重他人，保持友善
• 接受建设性的反馈
• 专注于项目的最佳利益
• 遵守开源社区规范

许可证

本项目遵循 GitCoffee Open Source License，贡献者提交的代码将自动采用相同的许可证。