扫码阅读
手机扫码阅读

开源礼节

51 2024-04-16

GitHub地址: https://github.com/JunManYuanLong,欢迎各位光临。

提出小Pull Requests。研究表明,变更内容的大小与审查质量之间存在很强的相关性:较大的变更(请求)对质量有负面影响。该项研究强烈建议开发人员进行小的,增量的更改。

文档中使用规范的Markdown语法。虽然没有对文档进行研究。但是规范的纯文本文档对于阅读文档的人来讲是一件非常轻松的事情,而且对于消化文档的内容也是有很大的帮助。

使用礼节性的用词:谢谢抱歉。这并不是说开源项目的维护人员,也完全适用于所有的编码人员。有很多关于在线交流礼节性的文章,基本原则上都是相同的:好问感恩承认不足

描述性的提交。格式化Git提交消息的格式通常在每个项目中都很具体。但是,存在一些相似性和通用规则。良好的提交习惯有助于维护者追根溯源,了解代码的更改历史。对于阅读者来讲,也可以了解到更新代码的功能和实现思路。

有一个头像。研究表明,具有头像的用户(尤其是女性化和拟人化的头像)比没有个人头像(或使用GitHub提供的默认头像)的用户更容易引起关注。当然,重要的不仅是虚拟形象,GitHub个人资料还有许多其他内容: 个人描述电子邮件等等。

经常在线。长时间离线通讯会导致很多问题。当维护团队和用户之间遇到了一个问题或者处理一个issue时,及时参与讨论并发表自己的看法非常重要。无论是正面还是负面的看法都需要及时交流,离线等待往往会伤害到项目。

规范的报告。就像Git提交一样,错误报告规范因项目而异,但是基本原理保持不变。只是如何避免写一个错误报告bug报告证明问题已经得到解决,代码甚至比之前的更好。可以通过各种途径来学习、交流技术和知识,也是一个自我提升的途径。

优雅的README。在README开源项目中书写和格式化文件的重要性无需赘述。编写良好的代码很重要,但呈现它是在线礼节的一部分:高质量的文档代表了维护人员对用户的尊重。

原文链接: https://mp.weixin.qq.com/s?__biz=MzU4MTE2NDEyMQ==&mid=2247487937&idx=1&sn=11028ea088492f301d1c9c12975d09f1