菜单

为 OSSU 贡献

相关源文件

本文档为社区成员提供了关于如何为 OSSU 计算机科学课程开发做出贡献的全面信息。它涵盖了接受的各种贡献类型、评审流程以及社区参与机会。

有关贡献的具体分步说明,请参阅 如何贡献。有关过去的课程变更和演变信息,请参阅 版本历史

贡献概述

OSSU 接受多方面的贡献,从简单的维护任务到实质性的课程改进。贡献系统旨在保持课程质量,同时实现社区驱动的演进。

贡献工作流程系统

来源:CONTRIBUTING.md1-20 FAQ.md7 FAQ.md99

贡献类型

非实质性更改

非实质性贡献包括不影响课程内容或学习进度的维护和更正。这些更改可以直接通过拉取请求提交,无需事先讨论。

示例包括

  • 当平台迁移内容时更新课程 URL
  • 拼写、语法和用词纠正
  • 格式改进和一致性修复
  • 修复损坏的链接
  • 对现有文本进行的小幅澄清

来源:CONTRIBUTING.md3-4

实质性更改

实质性贡献包括对课程内容、课程选择或学习进度的修改。这些需要通过 GitHub issue 事先讨论,并且必须符合既定的课程指南。

评估标准

  • 符合 CURRICULAR_GUIDELINES.md 标准
  • 必修与选修主题的覆盖范围
  • 课程质量和可访问性评估
  • 课程进度逻辑

示例包括

  • 提出新课程以填补课程空白
  • 建议用更高质量的替代课程来替换现有课程
  • 识别重复的课程覆盖
  • 重组学习路径

来源:CONTRIBUTING.md5-12

社区贡献流程

来源:CONTRIBUTING.md14-17

社区参与机会

问题响应与管理

积极的社区参与不仅包括提出更改,还包括参与现有的讨论和提案。

响应活动

  • 添加表情符号反应以表示支持或担忧
  • 对提议的更改提供详细反馈
  • 测试建议的课程并报告体验
  • 帮助评估课程质量和可访问性

学生指导

社区成员可以通过支持新学生和培养学习社区来做出贡献。

指导活动

  • 欢迎新的 Discord 用户
  • 加入或组建学习小组
  • 分享学习经验和学习策略
  • 在学习困难课程时提供同伴支持

来源:CONTRIBUTING.md16-17

质量保证框架

符合课程指南

所有实质性贡献必须符合 CURRICULAR_GUIDELINES.md 中记录的既定课程标准。这些指南是评估拟议变更的权威参考。

指南整合

  • 课程选择必须符合质量和可访问性标准
  • 主题覆盖必须符合计算机科学学位要求
  • 先决条件和进度必须遵循逻辑学习顺序
  • 外部依赖项必须保持长期可用性

版本控制和文档

课程的更改会触发结构化的文档和版本控制流程,以保持历史透明度。

文档要求

  • 所有更改均在 CHANGELOG.md 中记录,并遵循语义版本控制
  • 主要更改(主题添加/删除)会增加主版本号
  • 次要更改(课程替换)会增加次版本号
  • 修补程序更改(外观更新)会增加修补版本号

来源:CONTRIBUTING.md7 FAQ.md99

个人定制

寻求根据个人用途调整课程的贡献者,应分支(fork)该仓库,而不是提出与既定指南相悖的课程变更。

定制流程

  • 分支(Fork) ossu/computer-science 仓库
  • 根据个人学习目标修改课程
  • 独立维护个人版本
  • 将定制内容作为替代方法与社区共享

Fork 方法可以保持主课程的一致性,同时允许个人进行实验和专业化。

来源:CONTRIBUTING.md18-20

贡献者仓库文件结构

核心贡献文档

文件路径目的贡献者角色
CONTRIBUTING.md主要贡献指南所有贡献者的主要参考
CURRICULAR_GUIDELINES.md学术标准和课程选择标准实质性变更的评估框架
FAQ.md社区问答通过贡献更新的活文档
CHANGELOG.md版本历史和变更文档每次接受贡献时都会更新

主要课程文件

文件路径贡献影响变更要求
README.md高 - 主要课程内容实质性更改需要讨论 issue
extras/courses.md中 - 补充资源可接受直接 PR 进行添加
extras/readings.md中 - 书籍推荐欢迎以质量为导向的补充
HELP.md低 - 社区资源链接接受非实质性更新

来源:CONTRIBUTING.md1-20 FAQ.md1-126