贡献指南

作者: molin | 发表于 2025-03-28 02:12:20 +08:00

介绍如何为本项目贡献代码

起步

0. 阅读贡献者公约

😄 参与贡献之前,我们希望您先阅读 贡献者公约,这有助于您了解贡献者应当遵循的基本规则。

1. 派生 Fork 仓库

确保选择正确的分支

分支 说明
main Hexo 构建,旧站点
dev Hugo 构建,新站点

2. 克隆仓库到本地

3. 编辑文档

确认负责的区域,如 ‘/content/zh/docs/’。

4. 推送至派生仓库

提交信息并未明确规范,但是请尽量遵守约定式提交,详情参阅 约定式提交

5. 提交合并请求 PR

目录结构说明

./
├── content/    # 主要代码,支持国际化多语言
│   ├── en/
│   ├── ja/
│   └── zh/
│       ├── docs/   # 通用文档
│       └── posts/  # 游戏文章
│
├── static/ # 静态资源(图片音视频等)
│   ├── audio/
│   │   └── 1742721919.mp3
│   ├── img/
│   │   ├── 1742721344.avif
│   └── video/
│       └── 1742721919.webm
├── themes/
├── CODE_OF_CONDUCT.md  # 贡献者公约
├── hugo.toml   # Hugo 配置
├── LICENSE
└── README.md   # 项目自述

格式说明

文档编写以 Markdown 格式为主,以 Markdown 格式为例,基本语法参照 Markdown 教程,其他文档格式请参阅 Hugo

Front Matter

---
title: 当前语言作品名/更多别名
tags:
    - 测试1
    - 测试2
    - 测试3
categories:
    - 测试1
    - 测试2
date: 1970-01-01T08:00:00+08:00
author: 示例
---

正文大纲

基本脉络如下,若有其他内容可自行添加。

  1. 封面
  2. 概述
  3. 简介
  4. 链接
  5. 备注
  6. 引用

文件上传

文件命名

图片、音频等静态资源应以 Unix 时间戳 命名,可用 站长工具

文件格式首推 高质量压缩 的,具体格式如下,制作与转换可用在线工具 ImagesTool

图片 音频 视频
avif mp3 webm