From 7671f253f2e5aff3ac19843a9dec8817fb1188a8 Mon Sep 17 00:00:00 2001 From: Refael Ackermann Date: Fri, 20 Oct 2017 18:41:20 -0400 Subject: [PATCH] doc: add recommendations for first timers PR-URL: https://github.com/nodejs/node/pull/16350 Reviewed-By: Rich Trott Reviewed-By: Joyee Cheung Reviewed-By: Gireesh Punathil Reviewed-By: Gibson Fahnestock Reviewed-By: Anatoli Papirovski --- COLLABORATOR_GUIDE.md | 13 ++++++++----- doc/first_timer_badge.png | Bin 0 -> 1539 bytes 2 files changed, 8 insertions(+), 5 deletions(-) create mode 100644 doc/first_timer_badge.png diff --git a/COLLABORATOR_GUIDE.md b/COLLABORATOR_GUIDE.md index e96585f4fdbb75..b0db4aa92aa575 100644 --- a/COLLABORATOR_GUIDE.md +++ b/COLLABORATOR_GUIDE.md @@ -24,8 +24,9 @@ understand the project governance model as outlined in ## Issues and Pull Requests -Courtesy should always be shown to individuals submitting issues and -pull requests to the Node.js project. +Courtesy should **always** be shown to individuals submitting issues and pull +requests to the Node.js project. Be welcoming to first time contributors, +identified by the GitHub ![badge](./doc/first_timer_badge.png) badge. Collaborators should feel free to take full responsibility for managing issues and pull requests they feel qualified to handle, as @@ -68,6 +69,9 @@ wide-reaching impact), and focused changes that affect only documentation and/or the test suite, may be landed after a shorter delay if they have multiple approvals. +For first time contributors, ask the author if they have configured their git +username and email to their liking as per [this guide][git-username]. + For non-breaking changes, if there is no disagreement amongst Collaborators, a pull request may be landed given appropriate review. Where there is discussion amongst Collaborators, consensus should be @@ -362,10 +366,8 @@ The TSC should serve as the final arbiter where required. * If you do, please force-push removing the merge. * Reasons for not using the web interface button: * The merge method will add an unnecessary merge commit. - * The rebase & merge method adds metadata to the commit title. - * The rebase method changes the author. * The squash & merge method has been known to add metadata to the - commit title. + commit title (the PR #). * If more than one author has contributed to the PR, keep the most recent author when squashing. @@ -675,3 +677,4 @@ LTS working group and the Release team. [backporting guide]: doc/guides/backporting-to-release-lines.md [Stability Index]: doc/api/documentation.md#stability-index [Enhancement Proposal]: https://github.com/nodejs/node-eps +[git-username]: https://help.github.com/articles/setting-your-username-in-git/ \ No newline at end of file diff --git a/doc/first_timer_badge.png b/doc/first_timer_badge.png new file mode 100644 index 0000000000000000000000000000000000000000..d275a14851f286a1d03d679f0e66766ab745b214 GIT binary patch literal 1539 zcmb7DeQXnD7(XP@xv&TZ7sQwx2Y*1|dUw5R?|QDl){oI-9kp9RgE97c_jbE%?Un1z z-6(;o3jv8_v0%CyO++W3B_gK|iCORum^K3(B!WS+bOVPN&`L^KP<*?s$RC8nH+T2G z?{m-Zd4A8=PG56lP4(hx1VL&%>zsbLOYnWRYA*a{8h3pSx92riKx)U)Y3P=_FMd*#-E7VtLlq7pF)WgU|qi9s}i)UDBDg4h8xGz8k@s2#g? zatK3Z$&PKXcu8-}0ovttn^n-Vxw%!`+#%W|Y|U!4PUoS42+#ynk90=kyl%&)?eg$k z784jct)g|yW7-Fn-sN;plmi9L7EA(8HXBpyeFy&Iv$NLtypk^ zxTwl8O;)04*`g3qx->fmna+d|iFv&b3`gU$iGnF3bRkAiCX$Fm%5hC=$2C9rkH#al z?LV4ZmKMVNrxmry_PmKveTM?HK%Hl4OZzZ4xJ0 zMFy9E72veMP&mhiDO{99nvtv_fu^h#JCDMzz)E%k5%0&SjxV zlC5Ap(YPi=MNsiAL*KJl`mtEvp#niu)K*35taO2|UD1?yyAnekj_InS%QwhTN$HNS zD3@s_Y9~pvpETD0U0?-;sN_d#Ea1ujXX@(7B1f)omTj!xxs)%5J zmX8kx1704C7Kp-mQsLmdb8OoYICOo!rdC&Gcq*SwCQ> zrt`yTBb&?&j~ip-iBvkECj+T;zLd+Pa+zW1;#@+P6Imk=l#64=SpI6UGzCe4XVzxm zMr!`%mizy2A)$fuI)coxdz|&H`cJ>_y{x`P&U0N2zW>Fl0Z&Hr+!=A-y+3qVx^SA& z`p@?5pFBl26#o2XG4iF0-L&wP<+a?VRn?QR!sPD0ZEN>kOy6iZc_*-Y!o9TCd|{~m z?30)KYlt;x8eguuJG!VLTzmGy;fp&iEjqRT<6XJEU&-QvEww*>dQ5w*pBVghvNt~A6+zK==={;squU4e9rEowx3}8)?#eBro%2HK!3EcRH`)&#XvgRG zcFG^TRMmCt+z*9)S@)i*J(28*1D1ip{9oSSdpbWk^J21iYT3{Nql9hmd)4#LsH3#b zoVZYc_l~y|YI^S-8Q%Kq>cRfo^FMt0g{H+nH(hGj zK8QVaVt@a#m4AIdP?y@6n=?^5eg8SNZ~fm(wr;%j#5}}tW?}fi(a(3lA|M`Dv-4;} H@Xdb#MfPzR literal 0 HcmV?d00001