779 Star 1.5K Fork 350

开源中国 / Gitee Feedback

 / 详情

代码说明文档

已完成
任务
创建于  
2017-05-29 13:50
  1. 大部分的 项目 都没有使用 Wiki,就算用了, 也只是简单的说明怎么使用
  2. 对我们程序员来说, 最主要的是 能快速了解项目的 背景,设计思路, 实现的功能,代码存在的目的... 然而这些都没有,以至于 很难投入到开源项目中贡献代码, 对于开源来说, 毫无意义
  3. 我觉得, 应该鼓励 项目开发者,尤其是公开的项目, 鼓励他们 多写WiKi, 详细的介绍自己的代码, 让更多人参与到项目中共同维护

评论 (3)

钟工 创建了任务

我们一直都很鼓励 :laughing: 不知道有没有更好的措施建议呢?

@Yashin 可以用gitbook, 用户只需要点击看不懂的代码,链接到gitbook看说明
而我们码农, 就可以针对每一句代码, 连接到gitbook, 不影响代码同时,增加了代码的可读性,
这项功能加上去, 将会远超 github, 就是不知道github有没有这样的功能

Yashin 关联项目Gitee 公有云服务(社区版) 修改为文档 Wikis(已删除)

wiki的重构考虑一下这个需求

Yashin 关联项目文档 Wikis(已删除) 修改为公有云-企业版
Yashin 里程碑设置为企业文档(已删除)
Yashin 里程碑企业文档(已删除) 修改为未设置
沈朝华 负责人设置为Roger
Roger 任务状态待办的 修改为已拒绝
Roger 任务状态已拒绝 修改为已完成

登录 后才可以发表评论

状态
负责人
项目
Pull Requests
关联的 Pull Requests 被合并后可能会关闭此 issue
分支
开始日期   -   截止日期
-
置顶选项
优先级
预计工期 (小时)
参与者(2)
58426 yashin 1578915792 472904 583876319 1578924969
Ruby
1
https://gitee.com/oschina/git-osc.git
git@gitee.com:oschina/git-osc.git
oschina
git-osc
Gitee Feedback

搜索帮助