开源协议专栏

[521xueweihan]

背景

开源协议是创建开源项目和项目走向正规化的必经之路，但是国内针对这部分的内容少之又少，导致大部分的开源作者对这部分不是很了解。

需求

HelloGitHub 网站开设一个开源协议的专栏，用来进行开源协议的介绍、特点说明、浏览明细（中文），为用户选择开源提供中文的可行性建议，第一版的主要功能为展示。

功能

首页：

1. 展示权限（permissions）类型的标签
2. 按照最新（last）和最热（hot）排序
3. 可以多选不同权限的（商用、分发、修改、专利）协议，过滤查看项目
4. 简单的翻页功能

原型和接口

优先完成详情页

首页

每行展示几个，可根据实际情况调整

接口：

• 首页：https://local.api.hellogithub.com/docs#/license/index_v1_license__get
  • tid：标签id，可多选例如：?tid=xxx&tid=xxx
• 标签：https://local.api.hellogithub.com/docs#/license/tag_v1_license_tags__get
  • tag_type：默认获取 permissions 类型的标签

详情

接口：https://local.api.hellogithub.com/docs#/license/license_detail_v1_license__lid__get

参数：

• lid：通过项目详情接口获取，对应 license_id 字段

细节：

• 标签在 hover 和 点击 的状态下，显示 tag 的 description
• 侧边栏获取指定开源协议的项目，接口 请求参数为 spdx_id（开源协议详情接口有这个字段）

认领翻译协议

接口：https://local.api.hellogithub.com/docs#/license/claim_license_v1_license__lid__claim__post

[github-actions[bot]]

Branch i78-开源协议专栏 created!

[521xueweihan]

@RJM1996 这个需求年前有时间的话就抽空看看， 协议页侧边栏推荐项目那个，我弄成了一个新需求，我弄完详情页改版就搞。

[521xueweihan]

侧边栏项目推荐已完成：https://github.com/HelloGitHub-Team/geese/blob/main/src/components/side/Recommend.tsx

推荐项目接口：https://local.api.hellogithub.com/docs#/repository/recommend_v1_repository_recommend__get

@RJM1996 如果有时间的话，可以先做协议详情页，入口在项目详情处：

[RJM1996]

协议列表和协议详情的整体框架已搭建完毕，剩余工作： 1、点击或鼠标悬浮协议权限等标签的 tooltip 展示

• 先自己实现 tooltip 组件，如果效果不太好再考虑是否用第三方插件
• 移动端没办法hover，设计交互为点击时使用底部抽屉展示标签说明

2、接口请求相关逻辑处理 3、细节调整，类型问题处理

@521xueweihan

[RJM1996]

协议首页和详情开发完毕，代码已提交，下面是功能清单和待优化的地方 @521xueweihan

功能清单

首页

• [x] 展示权限（permissions）类型的标签
• [x] 按照最新（last）和最热（hot）排序
• [x] 可以多选不同权限的（商用、分发、修改、专利）协议，过滤查看项目
• [x] 简单的翻页功能
• [x] 点击协议卡片跳转协议详情页面

详情页

• [x] 页面整体框架，协议内容展示
• [x] 问题反馈页面跳转
• [x] 协议标签信息tooltip展示，移动端底部抽屉展示
• [x] 一键分享链接
• [x] 协议详细内容的展开和收起
• [x] 右侧边栏协议相关的项目推荐

待完善

• [ ] 一键分享链接的内容可以再优化下，目前是这样

<a href="https://hellogithub.com/license/916bb214835c400facd967403545ddab?spdx=BSD-3-Clause" rel="nofollow">BSD 3-Clause "New" or "Revised" License</a>

• [ ] 协议标签的tooltip展示内容和样式可以再优化下

[521xueweihan]

@RJM1996 第一版仅上线了 License 详情页：https://hellogithub.com/license/801d1d4bdc8d455ca63cac19d0cc5a80

入口在 PC 访问的开源项目详情页左侧，样式做了优化。

因为，目前 header 位置有限，续会增加和提高 License 入口的优先级。