Go to file
bluejeams 3c6291140a 更新MVP计划示意图 2025-12-24 16:24:25 +08:00
governance 更新MVP计划示意图 2025-12-24 16:24:25 +08:00
LICENSE Add LICENSE 2025-12-24 14:23:14 +08:00
README.md 更新仓库README文件 2025-12-24 15:04:31 +08:00

README.md

Git4Edu | 开源课程协作开发Upstream仓库

Course as Code · Class as Community · Learning by Contributing

Course as CodeOpen Source EducationStatus MVPRelease R1License CC BY-SA 4.0


1. 仓库定位

Git4Edu 是一个以开源协作为核心的课程主仓Upstream Repository用于支撑高校与职业院校的开源课程体系共建、教学运行与持续演进

本仓库将课程视为一种可协作、可版本化、可复用的工程资产,通过 Git 与开源协作机制,构建“教学—实践—产出”一体化的课程运行模式。

对接专业:

  • 职业本科:开源技术开发与应用310216
  • 高职专科:开源技术应用510220

2. 课程设计理念

本课程体系遵循三条核心原则:

  • Course as Code
    课程内容即代码,讲义、实验、案例与规范全部以仓库形式管理,支持版本演进与协作共建。

  • Class as Community
    班级即社区,教学过程通过 Issue / PR / Review 的方式组织,而非单向授课。

  • Learning by Contributing
    学习以真实贡献为核心,学生在参与协作中完成能力成长与成果积累。


3. 课程体系架构设计

Git4Edu完整实现开源学习栈OSLS架构将教学活动系统化为五个协同层级

层级 名称 关注点
L1 Outcome Stack能力栈 学生最终可验证的能力产出
L2 Collaboration Stack协作栈 Issue / PR / Review / Release
L3 Toolchain Stack工程栈 Git 平台、CI、模板
L4 Courseware Stack内容栈 讲义、实验、案例
L5 Community Stack社区栈 班级运营与激励

Git4Edu 主要承载 L2L4 的核心资产并为能力评价L1与社区运行L5提供基础支撑。


4.仓库结构说明

Git4Edu用“仓库体系”代替“教研群文件”设计原则采用所有内容都应是 可复用、可协作、可引用 的课程资产,而非一次性教学材料。在此基础上,课程整体采用 “三仓一板” 的最小协作架构,以较低的复杂度实现完整的教学协作闭环:

Git4Edu仓库和数据体系结构
├── 📦 **Git4Edu本仓库** - 课程主仓:标准化课程资产源
├── 🏫 **班级组织仓** - 教学运行仓:各班级教学实例
├── 🎓 **学生作品仓** - 成果展示仓:学生个人/小组作品集
└── 📋 **课程协作看板** - 可视化看板:教学任务与进度管理

5. 协作方式

5.1 Git4Edu采用标准的开源协作流程

1. 发现需求 → 创建或认领 Issue
2. 讨论方案 → 在 Issue 评论区达成共识
3. 实现代码 → Fork → 本地开发 → 提交
4. 代码评审 → 创建 Pull Request → 等待 Review
5. 合并发布 → 通过 CI 检查 → Maintainer 合并 → 发布 Release

5.2 代码规范

- **文档提交**:使用 Markdown 格式,遵循现有文档结构
- **实验代码**:提供完整可运行的示例,包含详细注释
- **配置模板**:使用 YAML/JSON 格式,提供配置说明
- **提交信息**:遵循 [Conventional Commits](https://www.conventionalcommits.org/) 规范

5.3 贡献类型

可贡献内容包括但不限于:

贡献类型 适合人群 流程指引
课程内容贡献 教师、领域专家 修改 CURRICULUM/LABS_AND_EXERCISES/
教学资源贡献 教师、实践者 添加 COMMUNITY_RESOURCES/ 中的案例或指南
工具改进贡献 开发者、DevOps 优化 TOOLING_AND_CI/ 中的自动化流程
问题修复与反馈 所有使用者 提交 Issue 或修复文档错误
翻译与本地化 多语言贡献者 提交课程材料的翻译版本

6. 仓库角色

角色 说明
维护者 负责仓库结构、质量兜底与版本发布
贡献者 提交课程内容与改进
评审者 参与评审与质量保障
社区导师 提供工程与教学视角指导

⚠️ 重要说明: 核心维护者与关键贡献者并非无偿贡献者。 其持续性、高责任的维护与共建行为,将纳入课程的激励与评估体系。


7. 激励与评价机制

Git4Edu采用数据驱动的激励与评估机制

  • 基于 Issue / PR / Review / Release 等真实协作数据
  • 明确区分核心维护贡献、核心内容贡献与一般贡献
  • 通过贡献证明、署名、生态推荐及必要的经济激励进行兑现

目标不是追求贡献数量,而是保障高质量协作的可持续性


8. 许可证

本项目源代码采用 MIT License 进行许可,允许在满足许可证条款的前提下,自由地使用、复制、修改、合并、发布、分发、再许可和/或销售软件的副本。

所有研究成果(包括但不限于论文、数据、图表、模型、方法论描述等)默认使用 知识共享署名-相同方式共享 4.0 国际许可协议 (CC BY-SA 4.0) 进行许可。