Gollum Wiki 项目开发指南：从环境搭建到贡献流程

Gollum Wiki 项目开发指南：从环境搭建到贡献流程

gollum A simple, Git-powered wiki with a sweet API and local frontend. 项目地址: https://gitcode.com/gh_mirrors/go/gollum

前言

Gollum 是一个基于 Git 的轻量级 Wiki 系统，采用 Ruby 开发。作为技术专家，我将详细介绍如何为 Gollum 项目贡献代码，包括环境配置、问题提交规范、开发流程等核心内容。

开发环境配置

基础工具准备

在开始 Gollum 开发前，需要安装以下基础工具：

1. Git：版本控制系统，建议使用最新稳定版
2. Ruby：Gollum 的核心开发语言，推荐 2.7+ 版本
3. Node.js：前端资源管理依赖，建议 LTS 版本

依赖管理工具

Gollum 使用两种包管理工具：

1. Bundler：Ruby 依赖管理

   gem install bundler
   

2. Yarn：JavaScript 依赖管理

项目初始化步骤

1. 克隆仓库：

   git clone <仓库地址>
   cd gollum
   

2. 安装 Ruby 依赖：

   bundle install
   

3. 安装前端依赖：

   yarn install
   

4. 配置 Git 默认分支（测试需要）：

   git config --local init.defaultbranch=master
   

问题跟踪与提交规范

有效问题类型

Gollum 项目主要关注两类问题：

1. Bug 报告：软件缺陷或异常行为
2. 功能请求：新特性建议

问题提交前检查

在提交问题前，请确认：

1. 问题是否已在现有 issue 中提及
2. 文档（如 README）是否已包含解决方案
3. Wiki 中是否有相关说明

安全问题报告

安全相关问题应直接联系维护者，使用提供的 GPG 密钥进行加密通信。

开发工作流程

分支策略

1. 从主分支创建特性分支
2. 使用描述性分支名称
3. 保持提交历史清晰

测试规范

Gollum 采用全面的测试套件：

1. 运行全部测试：

   bundle exec rake test
   

2. 详细模式（分析慢测试）：

   bundle exec rake test TESTOPTS="--verbose"
   

3. 运行单个测试文件：

   bundle exec ruby test/test_file.rb
   

测试仓库操作

Gollum 提供示例测试仓库（如 lotr.git），开发者可以：

1. 克隆测试仓库
2. 添加测试文件
3. 提交变更并推送到测试仓库

前端资源管理

Gollum 使用现代前端工具链：

1. Yarn：管理 JavaScript 依赖
2. Sprockets：资源打包工具

开发模式

使用 --development-assets 标志运行 Gollum，可直接使用未打包的源文件进行开发：

bundle exec gollum --development-assets

静态资源更新

修改前端资源后需执行：

git rm -r lib/gollum/public/assets
bundle exec rake precompile
git add lib/gollum/public/assets
git commit

版本发布流程

Gollum 遵循语义化版本控制（SemVer）：

• 补丁版本（z）：

  rake bump
  rake release
  

• 主/次版本（x.y）：

  1. 手动更新 lib/gollum.rb 中的 VERSION
  2. 执行：

     rake gemspec
     rake release
     

结语

参与 Gollum 开发需要熟悉 Ruby 生态系统和前端工具链。本文详细介绍了从环境搭建到代码贡献的全流程，希望对开发者有所帮助。在开发过程中，保持与社区沟通，遵循项目规范，将有助于您的贡献被顺利接纳。

gollum A simple, Git-powered wiki with a sweet API and local frontend. 项目地址: https://gitcode.com/gh_mirrors/go/gollum