未加星标

On Cosmetic Changes in Pull Requests

字体大小 | |
[前端(javascript) 所属分类 前端(javascript) | 发布者 店小二03 | 时间 2018 | 作者 红领巾 ] 0人收藏点击收藏

Programmers, including myself, make cosmetic changes in code all the time, such as adding or deleting white spaces or blank lines, or re-wrapping lines, or adding { } to single-line if statements. That is usually fine. However, when making changes in other people’s code and sending pull requests on Github, I suggest you refrain from introducing cosmetic changes. There are two reasons:

Such changes require unnecessary attention of the pull request reviewer. If you don’t know if the reviewer is busy or not, always assume he/she is extremely busy, so the best strategy is to bring the really minimal set of changes, and exclude all non-essential changes ( or save them for later ).

The author of the package may not really like the style of the cosmetic changes. This is worse. People can argue to death on style. Such changes are often red herrings and can quickly lead to bikeshedding . Unless you are going to take over the maintainership of a package, I recommend that you follow the style of the main author(s). Even if they use = for assignments, which makes absolutely no sense to you, you just use = (you can complain about it by yourself in your own room if that makes you feel better). FWIW, I use <- when I contribute to a package if its author uses <- . I don’t think there is any need to argue about it, and I wish people could be more tolerant with each other’s styles.

In summary, the whole point is “recognize the priorities”. Getting the pull request merged is more important, so you want to save the reviewer time. It is more important for the package maintainers to be happy so they can carry on (bear in mind that they will also have to maintain the code you contributed after you have left ), so you follow their own styles.


On Cosmetic Changes in Pull Requests

本文前端(javascript)相关术语:javascript是什么意思 javascript下载 javascript权威指南 javascript基础教程 javascript 正则表达式 javascript设计模式 javascript高级程序设计 精通javascript javascript教程

分页:12
转载请注明
本文标题:On Cosmetic Changes in Pull Requests
本站链接:https://www.codesec.net/view/611805.html


1.凡CodeSecTeam转载的文章,均出自其它媒体或其他官网介绍,目的在于传递更多的信息,并不代表本站赞同其观点和其真实性负责;
2.转载的文章仅代表原创作者观点,与本站无关。其原创性以及文中陈述文字和内容未经本站证实,本站对该文以及其中全部或者部分内容、文字的真实性、完整性、及时性,不作出任何保证或承若;
3.如本站转载稿涉及版权等问题,请作者及时联系本站,我们会及时处理。
登录后可拥有收藏文章、关注作者等权限...
技术大类 技术大类 | 前端(javascript) | 评论(0) | 阅读(9)