758 Unstar Star 1.2K Fork 344

开源中国 / Gitee Feedback

代码说明文档

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

Comments (3)

58426 yashin 1578915792
Yashin 2017-05-31 10:24

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

472904 583876319 1578924969
583876319 2017-06-03 16:48

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

58426 yashin 1578915792
Yashin 2019-03-04 15:34

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

Sign in to comment

Assignees
Labels
Not set
Projects
Milestones
Branches
Planed to start
Not set
Planed to end
Not set
Top level
Priority
Ruby
1
https://git.oschina.net/oschina/git-osc.git
git@git.oschina.net:oschina/git-osc.git
oschina
git-osc
Gitee Feedback

Search

132457 8cb2edc1 1899542 131848 70c8d3a4 1899542