开源松参与流程设计

菜谱
1

角色

  • sprint master：规划 sprint，协调任务设计和安排、设计和颁发徽章
  • mentor：项目负责人，帮助 contributor 解答任务相关的疑问以及 review PR
  • contributor：认领并完成任务

Sprint planning

Sprint 是指一个开发周期，在开源松的设定中，每个 sprint 一个月。contributor 需要在一个月内完成任务，提交 PR。

在每个 sprint 开始前：

  • sprint master 为参与项目创建徽章，并更新到代码厨房项目列表，为参与者创建相应的群组
  • mentor 需要进行项目报名
  • mentor 报名通过后为所有的任务创建话题（选择开源松分类），先不公开任务。话题标题格式为「:evergreen_tree:[项目名称] 任务描述」。如果有相关 GitHub issue，为 issue 添加标签 “codekitchen-soos”。任务话题建议包含如下内容：
    • 项目链接
    • 难度等级
    • 任务描述（验收标准）
    • 相关参考信息

开发流程

sequenceDiagram
    participant mentor
    participant contributor
    mentor->>contributor: 介绍项目和任务
    mentor->>contributor: 创建任务话题，添加 sprint <n> 和 todo 标签
    Note left of mentor: Kickoff 
    contributor->>mentor: 在感兴趣的任务话题下留言认领并备注自己的 GitHub username
    mentor->>contributor: 分配任务给合适的 contributor，并给任务话题添加 ing 标签
    Note left of mentor: 如果有对应的 GitHub issue，<br/>需要同时 assign 并添加<br/>标签 “codekitchen-soos”
    loop 讨论任务
        mentor-->contributor: 讨论需求，在任务话题使用中文，在 GitHub issue 使用英文
    end
    contributor->>mentor: 创建 PR 并把链接贴到任务话题
    mentor->>contributor: 为 PR 添加标签 “codekitchen-soos”
    loop 审核 PR
        mentor->>contributor: 提交 review 并进行讨论。在任务话题使用中文，在 GitHub PR 页面使用英文
    end
    mentor->>contributor: 合并 PR，给任务话题添加 done 标签
    Note right of contributor: Retro 和颁发徽章

Sprint retro

  • 在这个帖子打卡、写总结和反馈
  • 清理未完成任务
  • 颁发开源松相关徽章

Todo

  • 撰写开源松的整体介绍，放到使用手册