Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
154 lines (112 loc) · 4.72 KB

CONTRIBUTING.md

File metadata and controls

154 lines (112 loc) · 4.72 KB

贡献指南

AI Generated

欢迎来到 github-stars-search 项目的贡献指南！我们很高兴您有兴趣为这个项目做出贡献。

AI生成内容政策

本项目有一个特殊的要求：所有代码、文档以及其他任何材料必须完全由AI生成。这是我们项目的核心原则之一。

为什么要有这个要求？

  1. 保持一致性：确保整个项目的风格和质量保持一致
  2. 探索AI能力：测试和展示AI在软件开发中的潜力
  3. 学习目的：通过AI辅助开发来学习新技术和最佳实践
  4. 创新实验：作为一个完全由AI驱动的项目的实验案例

贡献规则

当您为本项目做贡献时，请遵守以下规则：

  1. 所有代码必须由AI生成

    • 不允许手动编写代码
    • 可以使用任何AI工具（如GitHub Copilot、ChatGPT、Claude、Qwen等）
    • 鼓励使用自然语言描述功能需求，让AI生成具体实现
    • AI生成的代码应该包含适当的类型定义和错误处理

  2. 所有文档必须由AI生成

    • README.md、CONTRIBUTING.md 等文档文件
    • 代码注释和函数文档字符串
    • 项目描述和用户指南
    • 技术文档和API文档

  3. 所有其他材料必须由AI生成

    • 配置文件（package.json、tsconfig.json等）
    • GitHub Actions 工作流文件
    • 测试用例和测试脚本
    • 项目规划和架构设计文档
    • 问题报告和解决方案

技术栈要求

为确保项目一致性，所有贡献应使用以下技术栈：

  • 前端: React 18, TypeScript, Vite, CSS3
  • 后端: Node.js 24, TypeScript, GitHub Actions
  • API: GitHub GraphQL API
  • 包管理: pnpm
  • 搜索: FlexSearch
  • 部署: GitHub Pages

如何贡献

  1. Fork 本仓库

    • 点击 GitHub 页面右上角的 Fork 按钮
    • 将仓库克隆到本地

  2. 使用AI工具生成代码/文档

    • 选择您喜欢的AI工具
    • 提供清晰的功能需求描述
    • 让AI生成符合项目技术栈的代码
    • 确保生成的代码遵循项目的编码规范

  3. 测试AI生成的内容

    • 在本地环境中测试生成的代码
    • 确保功能正常工作
    • 验证代码质量和性能

  4. 提交 Pull Request

    • 创建一个描述性的分支名
    • 提交您的更改
    • 在PR描述中详细说明：
      • 使用了哪个AI工具（包括版本）
      • 实现的功能或解决的问题
      • 用于生成代码的提示词（可选但推荐）
      • 测试结果和验证步骤

代码审查标准

我们会审查所有提交的PR，主要关注：

  • AI生成质量：代码是否完全由AI生成且质量良好
  • 功能正确性：功能是否正确实现且没有bug
  • 代码质量：代码是否清晰、可维护、符合TypeScript规范
  • 架构一致性：是否符合项目整体架构和设计模式
  • 性能考虑：是否考虑了性能优化（如搜索性能、渲染性能等）
  • 错误处理：是否包含适当的错误处理和边界情况处理
  • 文档完整性：是否包含必要的注释和文档

开发环境设置

如果您需要为项目做贡献，请确保您的开发环境正确配置：

# 克隆仓库
git clone https://github.com/your-username/github-stars-search.git
cd github-stars-search

# 安装前端依赖
pnpm install

# 安装Action依赖
cd action
pnpm install
cd ..

# 启动开发服务器
pnpm run dev

测试要求

所有AI生成的代码都应该经过充分测试：

  • 前端组件测试：确保React组件正常工作
  • Action测试：确保GitHub Action能正确获取和处理数据
  • GraphQL查询测试：确保GraphQL查询语法正确且能获取预期数据
  • 集成测试：确保整个系统正常工作

常见贡献类型

  1. 功能增强

    • 添加新的搜索过滤选项
    • 改进用户界面
    • 优化性能

  2. Bug修复

    • 修复GraphQL查询问题
    • 解决前端渲染问题
    • 修复数据处理错误

  3. 文档改进

    • 更新README.md
    • 添加技术文档
    • 改进代码注释

  4. 架构优化

    • 重构代码结构
    • 改进类型定义
    • 优化构建流程

开始贡献

如果您是第一次为本项目贡献，请先阅读我们的 README.md 文件了解项目的基本信息，然后查看 GRAPHQL_ISSUES_REPORT.md 了解项目的技术细节和已知问题。

联系方式

如果您有任何问题或需要帮助，请通过以下方式联系：

  • 创建GitHub Issue
  • 在Pull Request中@维护者
  • 参与项目讨论

感谢您的理解与合作！让我们一起探索AI在软件开发中的无限可能，创造一个完全由AI驱动的优秀项目。