Back to Details

code-story

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Code Story Skill

Code Story 技能

Provides narrative templates for transforming git history into documentary-style stories.
提供可将Git历史记录转化为纪实风格故事的叙事模板。

Templates

模板

Read the appropriate template based on detail level:
  • references/minimal-template.md - 1-2 page executive summary
  • references/standard-template.md - 5-10 page story with acts
  • references/comprehensive-template.md - 20+ page deep dive
根据详细程度选择对应的模板：
  • references/minimal-template.md - 1-2页的执行摘要
  • references/standard-template.md - 5-10页带篇章结构的故事
  • references/comprehensive-template.md - 20页以上的深度剖析

Narrative Guidelines

叙事指南

Voice and Tone

语气与风格

  • Documentary style: informative yet engaging
  • Third-person perspective
  • Acknowledge the human element
  • Find the drama in technical decisions
  • Celebrate achievements without hyperbole
  • 纪实风格：兼具信息量与吸引力
  • 第三人称视角
  • 体现人文元素
  • 挖掘技术决策中的戏剧性
  • 不过度夸张地展现成果

What Makes a Good Code Story

优质代码故事的要素

  • Genesis moment: First commit sets the stage
  • Character development: Contributors evolve
  • Conflict and resolution: Bugs, refactors, breaking changes
  • Turning points: Direction-changing decisions
  • Present connection: Link past to current state
  • 起源时刻：首次提交奠定基础
  • 角色成长：贡献者的能力进阶
  • 冲突与解决：Bug、重构、破坏性变更
  • 转折点：改变项目方向的决策
  • 当下关联：将历史与当前状态相联系

Commit Citation Format

提交引用格式

  • Short SHA in backticks: 
    abc1234
  • Include date and author for key commits
  • Link to GitHub if remote is github.com
  • 用反引号包裹短SHA值：
    abc1234
  • 关键提交需包含日期与作者信息
  • 若远程仓库托管在github.com，需添加GitHub链接