Skip to content

Latest commit

 

History

History
109 lines (74 loc) · 3.04 KB

File metadata and controls

109 lines (74 loc) · 3.04 KB

贡献指南

感谢您考虑为网站检查系统做出贡献!这是一个开源项目,我们欢迎任何形式的贡献。

如何贡献

报告Bug

如果您发现了bug,请创建一个issue,并尽可能详细地描述问题:

  1. 使用清晰的标题描述问题
  2. 描述重现问题的步骤
  3. 描述您期望的行为
  4. 描述实际发生的行为
  5. 提供截图(如果可能)
  6. 提供您的环境信息(操作系统、浏览器版本等)

提出新功能

如果您有新功能的想法,请创建一个issue:

  1. 使用清晰的标题描述功能
  2. 详细描述该功能应该如何工作
  3. 解释为什么这个功能对项目有价值
  4. 如果可能,提供一些实现思路

提交代码

  1. Fork 本仓库
  2. 创建您的特性分支 (git checkout -b feature/amazing-feature)
  3. 提交您的更改 (git commit -m 'Add some amazing feature')
  4. 推送到分支 (git push origin feature/amazing-feature)
  5. 开启一个 Pull Request

代码风格

  • 遵循项目现有的代码风格
  • 使用有意义的变量名和函数名
  • 添加必要的注释,但避免过度注释
  • 确保代码通过所有测试

开发环境设置

请参考README.md中的安装说明来设置您的开发环境。

分支策略

  • main 分支是最新的稳定版本
  • 开发新功能时,请从main分支创建新的特性分支
  • Pull Request应该提交到main分支

提交信息规范

请使用清晰的提交信息,遵循以下格式:

<类型>: <描述>

[可选的详细描述]

[可选的相关issue]

类型可以是:

  • feat: 新功能
  • fix: 修复bug
  • docs: 文档更改
  • style: 不影响代码含义的更改(空格、格式等)
  • refactor: 既不修复bug也不添加功能的代码更改
  • perf: 提高性能的代码更改
  • test: 添加或修正测试
  • chore: 对构建过程或辅助工具的更改

例如:

feat: 添加网站批量导入功能

添加了从CSV文件批量导入网站的功能,用户可以通过上传CSV文件一次添加多个网站。

Closes #123

行为准则

我们的承诺

为了营造一个开放和友好的环境,我们作为贡献者和维护者承诺,无论年龄、体型、能力、种族、性别认同和表达、经验水平、国籍、个人外表、种族、宗教或性认同和取向如何,参与我们的项目和社区的每个人都不会受到骚扰。

我们的标准

有助于创建积极环境的行为包括:

  • 使用友好和包容的语言
  • 尊重不同的观点和经验
  • 优雅地接受建设性批评
  • 关注对社区最有利的事情
  • 对其他社区成员表示同理心

不可接受的行为包括:

  • 使用性化语言或图像以及不受欢迎的性关注或advances
  • 挑衅、侮辱/贬低性评论以及个人或政治攻击
  • 公开或私下骚扰
  • 未经明确许可发布他人的私人信息,如物理或电子地址
  • 其他在专业环境中被合理认为不适当的行为

许可证

通过贡献您的代码,您同意您的贡献将在MIT许可证下获得许可。