文档章节

参与贡献

参与 Hugo 项目的开发、文档与主题贡献。

三种参与方式

Hugo 是一个由社区驱动的开源项目,任何人都可以参与其中。整体上,参与贡献可以分成三类工作:

  • 参与开发:报告与修复缺陷、改进功能、在论坛回答提问、关注议题队列、创建或改进主题,并按照规范的 GitHub 工作流提交补丁。
  • 参与文档:官方文档位于独立的仓库,欢迎对既有文档的修正与改进;新功能的文档通常随代码一并发起拉取请求。
  • 参与主题:把自制主题提交到社区主题站点,供其他用户浏览与使用。

从哪里开始

  • 遇到问题或需要讨论时,先在论坛搜索与提问,确认所需能力是否已经存在。
  • 想要新增功能时,先在论坛的 Feature 分类发起话题,用来确认能力是否已存在、衡量社区兴趣并打磨想法。兴趣足够后可以提交正式提案;在项目负责人接受提案之前,不要提交拉取请求。
  • 提交代码前先阅读项目的贡献指南,并按项目仓库与文档仓库各自的约定书写提交信息。
  • 提交补丁前请在本地构建并通过测试,确保改动不会破坏既有行为。

本节后续内容

本节余下的页面分别展开这三类工作:

  • 参与开发介绍贡献方式、功能提案流程、构建与测试要求,以及提交补丁的完整步骤。
  • 参与文档介绍文档仓库、写作与 Markdown 约定、前置元数据要求,以及本地预览与提交流程。
  • 参与主题介绍社区主题站点与主题提交方式。

本章内容

  • 参与开发 参与 Hugo 开发:贡献方式、功能提案、构建测试与提交补丁的流程。 (今天)
  • 参与文档 参与 Hugo 文档:仓库分工、写作与 Markdown 约定、提交流程。 (今天)
  • 参与主题 把自制 Hugo 主题提交到社区主题目录的方式。 (今天)