Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
128 lines (82 loc) · 3.42 KB

CONTRIBUTING.md

File metadata and controls

128 lines (82 loc) · 3.42 KB

为 Repo Viewer 贡献代码

感谢您对 Repo Viewer 项目的贡献兴趣！我们很高兴与您一起工作，并感谢您帮助使这个项目变得更好！

我们的协作方式

由于项目作者的水平有限，本项目的大部分代码由 AI Agents 完成（在开发者监督和审查下）。作者也在通过这个项目进一步学习。

是的，你没有听错，本项目几乎由人工智能驱动！错误和不完善之处在所难免。正因如此，我们非常欢迎您的贡献，以帮助修复错误、改进功能和提高代码质量！

为了保证协作的顺畅，在合并代码前，你需要阅读以下规范：

快速入门

1. 在本地部署项目

  • 克隆仓库

    git clone https://github.com/CQUT-OpenProject/Repo-Viewer.git
cd Repo-Viewer

  • 安装依赖

    vp install

  • 创建环境配置：复制 .env.example 到 .env 并配置必要的环境变量（参见下方内容）

    cp .env.example .env

  • 启动开发服务器 开发服务器、预览、构建与校验统一由 Vite+ 提供。

    vp dev

2. 创建功能分支

重要：master是我们的生产分支，dev是开发分支。任何修改请先合并至dev分支。

git checkout dev
git pull origin dev
git checkout -b branch-name/your-description

3. 进行代码更改

4. 自行测试所有内容

在提交 PR 之前，确保通过统一校验，不推荐出现任何的错误或警告：

vp check

同时请确保代码质量和部署通过，我们不会对 PR 进行任何审查。若预览分支出现问题，我们会直接撤销你的合并请求。

5. 提交您的 PR

  • 以 dev 分支为目标
  • 编写清晰的描述
  • 引用任何相关 issue

开发指南

分支命名规范

  • master：生产就绪的代码
  • dev：开发/预览分支 - 【PR的目标分支】
  • feature/：添加新的功能
  • enhancement/：功能增强
  • chore/：修改文档或其它操作
  • fix/：修复 bug 或已知的 issue
  • refactor/：重构代码实现或项目架构

推荐于此规范中选择分支的命名

我们期望的代码标准

  1. 代码职责最小化
  2. 文件分类正确且清晰
  3. 添加或删除依赖后，及时更新相关文档
  4. 注释简洁，不必添加过多说明，除非改动可能引起的其它后果
  5. 谨慎进行大范围重构或技术栈变更，同时需要在 PR 中说明相关变更理由
  6. 项目默认依赖 React Compiler 负责渲染级 memo 化，新增代码避免习惯性引入 useCallback、memo 或 React.memo

代码格式化

我们使用 EditorConfig 进行统一格式化，请确保你的编辑器安装了相应插件以自动应用格式规则。

提交 issue

[bug]

  • 存在问题的分支
  • 问题重现步骤
  • 期望行为 vs 实际行为
  • 错误日志

[enhancement]

  • 清晰地描述增强点，杜绝抽象概念
  • 建议的实现逻辑

[feature]

  • 功能用途说明
  • 清晰的功能描述，杜绝抽象概念
  • 建议的实现逻辑

推荐保持与历史 issue 一致的标题格式

许可证

通过贡献，您同意您的贡献将按照与项目相同的许可证 AGPL-3.0 进行许可。

感谢您为 Repo Viewer 做出的贡献！ 🎉

您的贡献有助于为每个人提供更好的 GitHub 仓库浏览体验。