search

Bio-OS / bioos

Apache License 2.0
58 stars 16 forks source link

任务挑战赛-【赛题解读】T3: 命令行工具实现Bio-OS Notebook使用 #21

Open yifanchen90 opened 1 year ago

yifanchen90 commented 1 year ago

背景介绍​

Bio-OS 作为一个开源开放的生信分析平台，目前已支持使用命令行工具bioctl使用命令行运行Bio-OS, 本赛题则是基于已有的Bioctl命令行工具进行功能拓展，此赛题需参赛人员具备go语言的相关知识，并熟练掌握后端开发及调试工具。 ​

任务介绍​

该赛题要求参赛团队基于Bio-OS现有的Bioctl命令行进一步扩展，支持通过Bioctl命令行实现Notebook的启动，运行配置修改，遍历Notebook实例及终止Notebook运行，需要参赛人员了解的内容包括

  1. 了解Bio-OS的架构和工作原理
  2. 了解Bioctl的架构和工作原理
  3. 以Bioctl为基础，开发使用Notebook相关的command
  4. 仅需支持http连接即可
  5. 需要完成命令行模式+交互模式

提交内容

请将以下提交内容发送到邮箱: bioosopensource@163.com

  1. 一个名称为"任务挑战-T3-队伍名称"的md或word文件 （示例文档https://github.com/Bio-OS/bioos/blob/main/docs/static/%E6%96%B9%E6%A1%88%E8%AE%BE%E8%AE%A1%E6%A8%A1%E7%89%88.doc仅作为参考，非必须参照）
    • 对bioctl Notebook command的方案设计介绍
    • Bioctl Notebook功能使用说明
    • 包含一个视频链接（如上传到B站或其他网站，附上链接，如视频不大也可以直接发送邮箱）
  2. 将源代码提交PR到https://github.com/Bio-OS/bioos中 ，源代码文件中应包含如下
    • main.go(Notebook command入口)
    • list.go
    • start.go
    • editNotebookSetting.go
    • Stop.go

评分标准​

本次比赛的评分标准包括以下几个方面：​

  1. 难度基础分（权重10%）
    • T1：Notebook插件可视化工具集成 --难度基础分6分
    • T2：实现工作流运行任务监控 -- 难度基础分8分
    • T3：命令行工具实现Bio-OS Notebook使用 -- 难度基础分8分
    • T4：Bio-OS流程规范扩展 -- 难度基础分 10分
  2. 方案设计：监控方案的合理性、完整性和可扩展性。（权重20%） （示例文档https://github.com/Bio-OS/bioos/blob/main/docs/static/%E6%96%B9%E6%A1%88%E8%AE%BE%E8%AE%A1%E6%A8%A1%E7%89%88.doc 仅作为参考，非必须参照）
  3. Demo效果：DEMO效果展示，Demo视频中可尽量展示完整的操作及参数配置及结果生成。（权重20%）
  4. 代码实现：通过提交的源代码进行code review，将从代码质量、可维护性、可读性多个维度进行评分。（权重30%）
    • 代码质量：是否正确的实现了预期功能和需求，是否处理了预期的错误情况并提供了清晰地错误消息和处理方式，是否考虑可配置参数
    • 可维护性：是否易于修改和维护，包括代码的模块化程度、复用性，是否易于扩展
    • 可读性：代码是否易于阅读和理解，包括变量名、函数名、注释等命名是否清晰，代码结构是否合理
  5. 文档编写（20%）
    • 内容准确性：是否准确、完整、清晰的表达了所需信息
    • 文档可读性：文档的结构是否合理，逻辑清晰，是否易于阅读和理解，是否使用了恰当的图表和图片等