Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
274 lines (186 loc) · 8.95 KB

CONTRIBUTING.md

File metadata and controls

274 lines (186 loc) · 8.95 KB
Raw

贡献指南 —— 源码碑林投稿手册

"天道源码，众生皆可修。凡有志参悟者，开源宗不拒任何一位修士。" —— 开源宗·宗门碑铭

欢迎来到「编神纪」开源创作项目！无论你是刚踏入编译之境的新手修士，还是已臻架构之巅的绝世大能，这里都有属于你的修行之路。本手册将引导你完成第一次Commit——在开源宗，这被视为正式入门的仪式。

目录

  1. 如何报告Bug（提交剧情漏洞）
  2. 如何修复错别字（最简单的入门贡献）
  3. 如何投稿番外/同人
  4. 如何向源码碑林投稿术式
  5. 如何参与百科/世界观建设
  6. 如何参与翻译
  7. Commit信息规范
  8. 术式审核流程（Code Review）

1. 如何报告Bug（提交剧情漏洞）

在修行的过程中，你可能会发现天道源码中的逻辑漏洞——角色设定矛盾、境界体系不自洽、时间线错乱等。这些都是珍贵的Bug Report。

步骤：

  1. 前往 Issues 页面
  2. 点击「New Issue」
  3. 选择对应的模板：
    • 剧情Bug报告：剧情逻辑漏洞、设定矛盾
    • 错别字/语病报告：文字层面的错误
    • 世界观补充/质疑：对世界设定的疑问或补充建议
  4. 按模板填写信息，越详细越好
  5. 提交！

提示：提交前请先搜索已有Issue，避免重复报告。重复的Bug Report如同重复的异常捕获——虽无害，但浪费资源。

2. 如何修复错别字（最简单的入门贡献）

这是最适合新修士的入门方式。修复一个错别字，就完成了你在源码碑林的第一次Commit。

步骤：

  1. Fork本仓库：点击页面右上角的「Fork」按钮，将仓库复制到你的账户下
  2. 找到需要修改的文件：在你Fork的仓库中，导航到对应章节文件
  3. 点击编辑按钮（铅笔图标）：直接在GitHub网页上修改
  4. 修正错误：修改错别字或语病
  5. 填写Commit信息：格式参见 Commit信息规范
  6. 提交Pull Request：
    • 点击「Propose changes」
    • 然后点击「Create pull request」
    • 按照PR模板填写信息
  7. 等待审核

小贴士：即使只修正了一个标点符号，你的名字也会永远留在项目的Contributors列表中——如同名字被刻在源码碑林的石碑上。

3. 如何投稿番外/同人

你有自己的故事想在这个世界里展开？开源宗欢迎一切基于「编神纪」世界观的创作。

要求：

  • 内容必须基于「编神纪」已公开的世界观设定
  • 不得与主线正史产生不可调和的矛盾（如果你的故事需要修改设定，请先提Issue讨论）
  • 文件放置在 community/fan-fiction/ 目录下
  • 文件命名格式：作者名_标题.md
  • 请在文件头部注明： 
    ---
作者：你的名字
时间线：相对于主线的时间位置
涉及角色：
摘要：一句话描述
---

投稿步骤：

  1. Fork仓库
  2. 在 community/fan-fiction/ 下创建你的文件
  3. 提交PR，选择「番外/同人」类型
  4. 等待社区审核

4. 如何向源码碑林投稿术式

在「编神纪」的世界里，术式是修士战斗和日常的核心能力。如果你设计了一个新的术式，欢迎提交到源码碑林！

术式投稿格式：

在 community/spell-submissions/ 目录下创建文件，使用以下模板：

# 术式名称

## 基本信息
- **所属体系**：（如：编译系/网络系/数据库系/算法系等）
- **境界要求**：（最低需要什么境界才能施展）
- **灵感来源**：（基于什么CS概念）

## 术式描述
<!-- 这个术式做什么？视觉效果是什么样的？ -->

## 施展方式
<!-- 如何触发？有什么前置条件？ -->

## 优势与局限
<!-- 强在哪里？弱点是什么？ -->

## 与现有体系的关系
<!-- 是否克制/被克制于某些已有术式？ -->

审核标准：

  • 是否与现有术式体系自洽
  • 是否有合理的CS概念映射
  • 是否过于强大（平衡性）
  • 创意性和趣味性

5. 如何参与百科/世界观建设

「编神纪」的世界庞大而复杂，我们需要修士共同维护世界观百科。

可以贡献的内容：

  • 角色档案补充：为已有角色添加更多细节
  • 势力介绍扩展：丰富各宗门/组织的设定
  • 地理志补充：描绘修真世界的地形地貌
  • 历史编年：梳理世界的历史事件
  • 术语表维护：确保CS概念与修真概念的映射一致

步骤：

  1. 先在Issue中提出你想补充的内容，使用「世界观补充/质疑」模板
  2. 与社区讨论，确保不与已有设定冲突
  3. 获得认可后，Fork仓库并提交PR
  4. 百科内容放置在 worldbuilding/ 对应子目录下

注意：世界观设定需要高度的一致性。请务必先阅读已有设定文档，确保你的补充不会引发「设定冲突」——这在修真界，可是会引发天劫的。

6. 如何参与翻译

将「编神纪」带给全世界的修士！

当前需要的语言：

  • English（英语）
  • 日本語（日语）
  • 한국어（韩语）
  • 更多语言欢迎自荐

翻译规范：

  1. 翻译文件放在 translations/<语言代码>/ 目录下
  2. 保持与中文原版相同的目录结构
  3. 术语翻译请参考 translations/glossary.md（术语对照表）
  4. 如果遇到难以翻译的双关语/梗，请在译文中加注释说明

步骤：

  1. 在Issue中声明你要翻译的章节和目标语言（避免重复劳动）
  2. Fork仓库
  3. 按规范翻译
  4. 提交PR，选择「翻译」类型

翻译是最伟大的修行之一——你在两种语言之间架起桥梁，如同在两个平行世界之间打开虫洞。

7. Commit信息规范

为保持源码碑林的整洁，所有Commit信息需遵循以下格式：

<类型>(<范围>): <简述>

<详细描述（可选）>

类型说明：

类型 说明 示例
feat 新增内容（新章节、新设定） feat(卷一): 新增第四章正文
fix 修正错误（剧情Bug、逻辑漏洞） fix(卷一/第二章): 修正境界描述矛盾
docs 文档更新（百科、README） docs(世界观): 补充编译宗历史
style 格式调整（排版、标点） style(卷一): 统一省略号格式
refactor 重构（大幅改写但不改变剧情走向） refactor(卷一/第一章): 重写开场段落
chore 项目维护（配置、CI） chore: 更新Issue模板
community 社区贡献（番外、术式、翻译） community(番外): 新增《编译宗往事》

示例：

fix(卷一/第三章): 修正林轩境界从编译境直接跳到架构境的Bug

根据境界体系设定，编译境之后应该是运行境，而非架构境。
已修正相关段落描述。

Closes #42

8. 术式审核流程（Code Review）

在开源宗，每一份提交到源码碑林的内容都需要经过「术式审核」。这不是为了刁难你，而是为了确保天道源码的完整性和一致性。

审核流程：

提交PR → 自动检查 → 社区审阅 → 长老审核 → 合并
  ↓           ↓          ↓          ↓        ↓
 你的贡献   格式检查    同修反馈   最终决定   入碑林

第一关：自动检查

  • Markdown格式是否正确
  • 文件是否放在正确目录
  • Commit信息是否符合规范

第二关：社区审阅

  • 任何社区成员都可以Review你的PR
  • 请认真对待每一条评论
  • 对于建议性修改，你可以选择接受或礼貌地说明你的理由

第三关：长老审核

  • 项目维护者进行最终审核
  • 确保内容质量和设定一致性
  • 可能会要求修改（Request Changes）

审核标准：

  • 正确性：内容是否与已有设定一致
  • 质量：文字质量是否达标
  • 完整性：该补充的信息是否齐全
  • 格式：是否遵循项目规范

审核时间：

  • 错别字修正：通常1-3天内审核
  • 百科补充：3-7天
  • 番外/同人：7-14天
  • 大型贡献：视情况而定

耐心等待审核的过程，也是修行的一部分。正如编译需要时间，好的代码值得等待。

最后

感谢你阅读到这里。无论你选择何种方式参与，你都已经成为开源宗的一员。

"万法归一，一即是源。每一位贡献者的名字，都将铭刻在源码碑林之上，与天道源码同在。" —— 开源宗·贡献者之碑

如有任何疑问，欢迎在 Discussions 中提问。开源宗的前辈们会为你指引方向。

祝修行顺利，Commit无Bug！