贡献指南

如何贡献

贡献方式

• 代码贡献 - 提交 Pull Request
• 问题报告 - 提交 Issue
• 功能建议 - 在 Issue 中讨论
• 文档改进 - 修正错别字、补充说明

基本要求

• 文明友善，互相尊重
• 问题报告请提供截图或录屏
• 代码提交前请测试功能
• 遵循项目现有的代码风格

提交规范

提交信息格式

类型(范围): 简短描述

详细描述（可选）

提交类型

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

示例

feat(note): 添加笔记搜索功能
fix(ui): 修复移动端显示问题
docs: 更新安装说明

问题报告

报告要求

• 必须包含截图或录屏 - 帮助快速定位问题
• 详细描述问题现象
• 提供重现步骤
• 说明操作系统和浏览器版本

报告模板

## 问题描述

[详细描述问题]

## 重现步骤

1. 步骤 1
2. 步骤 2
3. 步骤 3

## 截图/录屏

[请上传截图或录屏文件]

## 环境信息

- 操作系统：
- 浏览器：
- 项目版本：

代码贡献

开发流程

1. Fork 项目
2. 创建功能分支：git checkout -b feature/your-feature
3. 提交代码：git commit -m "feat: your feature"
4. 推送分支：git push origin feature/your-feature
5. 提交 Pull Request

代码要求

• 保持代码简洁清晰
• 添加必要的注释
• 确保功能正常工作
• 遵循 TypeScript 规范

社区规范

行为准则

• 保持友善和尊重
• 鼓励建设性讨论
• 避免人身攻击
• 帮助新贡献者

沟通方式

• 使用中文或英文
• 问题讨论在 GitHub Issues
• 技术交流在 Discussions
• 保持耐心和理解

感谢

感谢所有为项目做出贡献的朋友！每一个贡献，无论大小，都让项目变得更好。

---

记住：这是一个小项目，简单直接最重要！