diff options
author | Refael Ackermann <refack@gmail.com> | 2017-10-20 18:41:20 -0400 |
---|---|---|
committer | Refael Ackermann <refack@gmail.com> | 2017-10-24 10:26:20 -0400 |
commit | 7671f253f2e5aff3ac19843a9dec8817fb1188a8 (patch) | |
tree | f7b43147a0e0a3fc12bdc75548bbb505103f68a4 | |
parent | 88799dd3da95bf0e8c79c8a3e5f2db280daaaf29 (diff) | |
download | android-node-v8-7671f253f2e5aff3ac19843a9dec8817fb1188a8.tar.gz android-node-v8-7671f253f2e5aff3ac19843a9dec8817fb1188a8.tar.bz2 android-node-v8-7671f253f2e5aff3ac19843a9dec8817fb1188a8.zip |
doc: add recommendations for first timers
PR-URL: https://github.com/nodejs/node/pull/16350
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
-rw-r--r-- | COLLABORATOR_GUIDE.md | 13 | ||||
-rw-r--r-- | doc/first_timer_badge.png | bin | 0 -> 1539 bytes |
2 files changed, 8 insertions, 5 deletions
diff --git a/COLLABORATOR_GUIDE.md b/COLLABORATOR_GUIDE.md index e96585f4fd..b0db4aa92a 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 Binary files differnew file mode 100644 index 0000000000..d275a14851 --- /dev/null +++ b/doc/first_timer_badge.png |