Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
154 lines (109 loc) · 3.09 KB

CONTRIBUTING.md

File metadata and controls

154 lines (109 loc) · 3.09 KB
Raw

贡献指南

感谢您对拉片工具项目的关注！我们欢迎任何形式的贡献，包括但不限于代码提交、问题报告、功能建议和文档改进。

如何贡献

报告问题

如果您发现了bug或有功能建议，请通过GitHub Issues提交：

  1. 前往Issues页面
  2. 点击"New Issue"
  3. 选择适当的模板（Bug报告或功能请求）
  4. 填写详细信息并提交

提交代码

  1. Fork项目

    • 点击GitHub页面右上角的"Fork"按钮

  2. 克隆您的Fork

    git clone https://github.com/yourusername/pian.git
cd pian

  3. 创建新分支

    git checkout -b feature/your-feature-name

  4. 进行更改

    • 编写代码
    • 添加测试（如果适用）
    • 确保代码符合项目风格
    • 更新文档（如果需要）

  5. 提交更改

    git add .
git commit -m "Add your feature description"

  6. 推送到您的Fork

    git push origin feature/your-feature-name

  7. 创建Pull Request

    • 前往您GitHub上的Fork页面
    • 点击"New Pull Request"
    • 填写详细描述并提交

代码规范

JavaScript代码风格

  • 使用2个空格缩进
  • 使用单引号字符串
  • 在语句末尾使用分号
  • 使用驼峰命名法命名变量和函数
  • 使用Pascal命名法命名类和构造函数

HTML/CSS代码风格

  • 使用语义化HTML5标签
  • 使用有意义的类名和ID
  • 保持CSS选择器简单
  • 避免使用内联样式

提交信息规范

提交信息应遵循以下格式：

类型(范围): 简短描述

详细描述（可选）

类型包括：

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

示例：

feat(editor): 添加表格编辑功能

新增了表格插入和编辑功能，用户可以在笔记中插入表格并编辑内容

开发环境设置

前置要求

  • Node.js (v14.0.0 或更高版本)
  • PHP (v7.0.0 或更高版本)
  • Web服务器 (如Apache或Nginx，用于测试PHP后端)

安装步骤

  1. 安装依赖

    npm install

  2. 启动开发服务器

    npm run dev

  3. 在浏览器中访问 http://localhost:8000

测试

在提交Pull Request之前，请确保：

  1. 所有现有测试通过
  2. 新功能有对应的测试
  3. 代码已通过lint检查

运行测试：

npm test

运行lint检查：

npm run lint

问题反馈

如果您在贡献过程中遇到任何问题，请：

  1. 查看现有Issues，确认问题是否已被报告
  2. 如果是新问题，创建详细的Issue报告
  3. 在开发讨论区提问

行为准则

请尊重所有项目参与者，保持友好和专业的交流态度。我们遵循贡献者公约的行为准则。

许可

通过贡献您的代码，您同意您的贡献将在MIT License下发布。

致谢

感谢所有为拉片工具项目做出贡献的开发者！