在 Devin 中试用 DeepWiki 处理私有仓库
DeepWiki

521xueweihan/HelloGitHub

菜单

贡献系统

相关源文件

本文档详细介绍了开发者向 HelloGitHub 贡献项目的系统，并说明了贡献项目的处理、评估和发布流程。有关内容组织和发布周期的信息，请参阅 内容系统。

概述

HelloGitHub 贡献系统旨在促进开源项目在 HelloGitHub 月度期刊的提交、评估和收录。该系统支持自我推荐（开发者推荐自己的项目）和第三方推荐（开发者推荐他人的项目）。

来源：README.md17 README.md34 .github/ISSUE_TEMPLATE/submit-en.yaml108-110 .github/ISSUE_TEMPLATE/submit-cn.yaml108-110

提交流程

提交流程通过 GitHub issue 模板进行标准化，提供中文和英文两种版本。这些模板确保为项目评估提供所有必需的信息。

提交渠道

项目可以通过以下两种主要渠道提交：

  1. GitHub Issue 模板 - 结构化表单，指导提交流程
  2. HelloGitHub 网站 - 通过 hellogithub.com 提供的备用提交方式

来源：.github/ISSUE_TEMPLATE/submit-cn.yaml .github/ISSUE_TEMPLATE/submit-en.yaml .github/ISSUE_TEMPLATE/config.yml3-5

所需信息

提交模板要求提供特定信息以促进评估过程：

字段描述必填
项目 URLGitHub 仓库 URL是
类别编程语言或特殊主题是
项目名称简短描述（≤50 个字符）是
项目描述详细说明（32-256 个字符）是
亮点项目亮点是
示例代码展示功能的代码片段否
截图/视频项目的视觉演示否

来源：.github/ISSUE_TEMPLATE/submit-en.yaml15-97 .github/ISSUE_TEMPLATE/submit-cn.yaml15-97

项目类别

项目可以根据 HelloGitHub 月度期刊的组织结构进行分类提交。这种分类有助于组织内容并使其易于目标受众访问。

来源：.github/ISSUE_TEMPLATE/submit-en.yaml24-47 .github/ISSUE_TEMPLATE/submit-cn.yaml24-47

评估流程

提交的项目将经过评估过程，以确定其是否适合收录到 HelloGitHub 月度期刊中。评估主要由仓库维护者和可能的其他核心贡献者负责。

评估标准

项目将根据符合 HelloGitHub 推广有趣、入门级开源项目使命的具体标准进行评估。

  1. 原创性 - 内容不应从其他来源复制
  2. 独特性 - 项目不应曾被收录
  3. 质量 - 项目必须符合 项目评审指南
  4. 可访问性 - 入门级项目，对初学者友好
  5. 兴趣因子 - 能激发兴趣并展示开源魅力的项目

来源：.github/ISSUE_TEMPLATE/submit-en.yaml102-108 .github/ISSUE_TEMPLATE/submit-cn.yaml102-108

贡献者鸣谢

HelloGitHub 拥有一套完善的系统，用于表彰那些提交的项目被收录到月度期刊中的贡献者。

基本认可

所有推荐的项目被收录到 HelloGitHub 月度期刊中的贡献者都会：

  • 在 contributors.md 文件中列出
  • 在其提交项目的 issue 中得到通知

核心贡献者身份

项目被收录到 HelloGitHub 的贡献者达到 10 个或以上即可获得“核心贡献者”身份，并在社区中获得特别认可。

来源：.github/ISSUE_TEMPLATE/submit-en.yaml108-110 .github/ISSUE_TEMPLATE/submit-cn.yaml108-110

完整的贡献流程

下图展示了从提交到发布和认可的整个贡献流程。

来源：README.md34 .github/ISSUE_TEMPLATE/submit-en.yaml .github/ISSUE_TEMPLATE/submit-cn.yaml

Issue 模板代码结构

提交系统围绕 GitHub issue 模板构建，以指导贡献者完成提交过程。这些模板定义在位于 .github/ISSUE_TEMPLATE/ 目录下的 YAML 文件中。

模板组件

中文和英文模板共享相同的结构。

来源：.github/ISSUE_TEMPLATE/submit-en.yaml .github/ISSUE_TEMPLATE/submit-cn.yaml

贡献者最佳实践

为增加项目被接受的机会，贡献者应遵循以下指南：

  1. 原创性 - 确保所有描述都是原创的，非复制内容
  2. 验证 - 通过在 HelloGitHub 网站上搜索来检查项目是否之前已被收录
  3. 合规性 - 阅读并遵守项目评审指南
  4. 完整性 - 填写提交模板中的所有必填字段
  5. 视觉支持 - 包含截图或 GIF 以更好地展示项目
  6. 代码示例 - 在适当时，提供简洁的代码片段来演示功能

来源： .github/ISSUE_TEMPLATE/submit-en.yaml102-112 .github/ISSUE_TEMPLATE/submit-cn.yaml102-112