码农不重视文档:开源项目深受其苦

GitHub 刚刚发布了《2017 开源调查》报告,这家知名编程社交网站走访了 github.com 社区内 3800 多个项目和超过 5500 名成员,并且与 500 名在 GitHub 项目生态系统之外的编程者们进行了交谈。本次调查涉及多方面,比如人们在为开源项目做开发、做贡献时遇到的问题,结果有 93% 的人对“不完整或令人困惑的文档”感到非常沮丧。

然而这没能出乎我们的意料,因为 GitHub 上确实有许多描述很稀疏的项目,缺乏如何去使用它们的知道。如果你的脑实力不够强大,肯定会独自栽在这上面。

很遗憾,很多码农忽视了文档对一个项目取得成功的重要性。科技作者 Mike Pope 曾经如此总结文档的需求:

我们需要告诉开发者,‘缺了文档,就等于废了项目’!(If it isn’t documented, it doesn’t exist.

你不仅必须写文档,还得在其中好好解释、教导和示范。这样的话,大家都会很高兴的。这不仅关乎你的文档,也关乎你的产品!

此外,Stack Overflow 创始人 Jeff Attwood、以及 JavaScript 开发者 Nicholas Zakas,也都在博文中强调过文档的重要性。

GitHub《2017 开源调查》中排名靠前的几个问题,在“文档不完整或困惑”之后,分别是“不回应”、“不屑”、“冲突”、“不明原因的拒绝”、以及“不欢迎的语言或内容”。

GitHub 在调查中强调:“文档有助于营造一个包容性的社区,清楚地解释了一个项目的过程,比如贡献指南和行为准则,大家会很珍视这样的开源工作、但它往往被低估”。

调查还指出,高达 60% 的贡献者很少或从未对文档提供过帮助。

原文地址:http://www.cnbeta.com/articles/soft/618585.htm


.NET社区新闻,深度好文,微信中搜索dotNET跨平台或扫描二维码关注

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/325344.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

kafka监控软件kafka-eagle搭建 web无法访问

https://www.likecs.com/show-204789016.html

《四世同堂》金句摘抄(三)

System.out.println("今天读的是什么书呢?"); String bname "《四世同堂》"; System.out.println("今天读的书还是:"bname);Console.WriteLine("今天读的是什么书呢?"); String bname "《四世…

[翻译]编写高性能 .NET 代码 第一章:性能测试与工具 -- 平均值 vs 百分比

平均值 vs 百分比 在考虑要性能测试的目标值时,我们需要考虑用什么统计口径。大多数人都会首选平均值,但在大多数情况下,这个正确的,但你也应该适当的考虑百分数。但你有可用性的要求,作为性能测试的目标里肯定会有用…

《四世同堂》金句摘抄(四)

System.out.println("今天读的是什么书呢?"); String bname "《四世同堂》"; System.out.println("今天读的书还是:"bname); System.out.println("在摘抄一下");下面是今天的摘抄内容 生在某一种文化中的人&a…

面对枯燥的源码,如何才能看得下去

转载自 面对枯燥的源码,如何才能看得下去 一个软件开发人员,工作到了一定的年限(一般是3、4年左右),如果他还没学会阅读源码,那么他就会遇到瓶颈。因为到了这个时候的开发,他应该不仅仅只会做…

前端防xss攻击(去掉空格等能影响和攻击数据库的字段)

用法:把要传给后端的数据放到此能过滤的函数里面即可就能实现自动过滤的功能 eg 代码 export function XSSFilter(str: string) {// 过滤emoji表情str str.replace(/\uD83C[\uDF00-\uDFFF]|\uD83D[\uDC00-\uDE4F]/g, );// 过滤所有html标签str str.replace(/&l…

《四世同堂》金句摘抄(五)

System.out.println("今天读的是什么书呢?"); String bname "《四世同堂》"; System.out.println("今天读的书还是:"bname); System.out.println("在摘抄一下");他们呆呆的看着他。惊异,怜悯&#…

[深圳/广州]微软SQL技术沙龙分享会(MVP)

[深圳/广州] 新一期俱乐部活动报名开始,这次是广深地区SQL Server 技术沙龙分享会(MVP),SQL Server作为一个数据平台,不管是SQL Server 2017 on Linux 还是把一门开源R语言融入其最赚钱的旗舰商业数据库,微软已经决定&…

搜索时展示的是名字,传给后端的是id

展示普通的select框 const [typeList, setTypeList] useState(["增加","减少"]);<Form.Item name"fruitType" label"类型" rules{[{ required: true }]}><Select style{{width:500}} placeholder"请选择类型">…

IntelliJ IDEA 2018.2 发布,支持 Java 11

转载自 IntelliJ IDEA 2018.2 发布&#xff0c;支持 Java 11 近期&#xff0c;JetBrains发布了其旗舰产品IntelliJ IDEA的2018.2版本。新版本支持即将推出的Java 11、断点意图&#xff08;Breakpoints Intentions&#xff09;、MacBook的Touch Bar等特性&#xff0c;并改进了…

发布支持多线程的PowerShell模块 —— MultiThreadTaskRunner

应用场景 多线程在需要批量处理一些任务的时候相当有用&#xff0c;也更加有利于充分利用现有计算机的能力。所有主流的开发语言都支持多线程。 默认情况下&#xff0c;PowerShell作为一个脚本语言&#xff0c;是不支持多线程操作的&#xff0c;虽然有所谓的后台任务&#xf…

java中,在一个有序数组中插入元素,使得数组保持有序排列

//已知有一个数组&#xff0c;/*数组里面的元素有a b c d e f y z,从控制台中随机输入一个字母&#xff0c;按照升序的顺序插入到该数组中并且遍历输出。*/public static void test1(){String [] str{"a","b","c","d","e",&…

架构师必须掌握的 10 条设计原则

转载自 架构师必须掌握的 10 条设计原则 01、 遵循单一职责原则 函数是程序员的工具中最重要的抽象形式。它们能更多地被重复使用&#xff0c;你需要编写的代码就越少&#xff0c;代码也因此变得更可靠。较小的函数遵循单一职责原则更有可能被重复使用。 02、 尽量减少共享…

《四世同堂》金句摘抄(六)

System.out.println("这两天还是读的《四世同堂》"); System.out.println("这本书好长啊"); System.out.println("不断的听&#xff0c;不断的看&#xff0c;才到1000多页");今天的金句摘抄&#xff1a; 她翻滚的闹&#xff0c;整桶的流泪&…

[翻译]编写高性能 .NET 代码 第一章:工具介绍 -- Visual Studio

Visual Studio vs虽然不是全宇宙唯一的IDE&#xff0c;但它是.net开发人员最常用的开发工具。它自带一个性能分析工具&#xff0c;你可以使用它来做开发&#xff0c;不同的vs版本在工具上会略有差别。 VS可以分析CPU使用率&#xff0c;内存分配以及资源锁情况。它能在你开发与…

Java 程序员必备的 Intellij IDEA 插件

转载自 Java 程序员必备的 Intellij IDEA 插件 来源&#xff1a;柠檬学园 以下是我用过不错的Intellij插件&#xff0c;分享给大家希望能帮到大家。 1. .ignore 地址&#xff1a;https://plugins.jetbrains.com/plugin/7495--ignore 生成各种ignore文件&#xff0c;一键创建g…

表单中去掉重置和提交按钮和搜索框

去掉重置和提交按钮 <ProFormsubmitter{{// 配置按钮文本searchConfig: {resetText: 重置,submitText: 提交,},// 配置按钮的属性resetButtonProps: {style: {// 隐藏重置按钮display: none,},},submitButtonProps: {},// 完全自定义整个区域render: (props, doms) > {c…

《四世同堂》金句摘抄(七)

System.out.println("这两天还是读的《四世同堂》"); System.out.println("这本书好长啊"); System.out.println("不断的听&#xff0c;不断的看&#xff0c;才到1000多页"); System.out.println("这几天没有好好的读&#xff0c;追求了速度…