Add instructions on how to use "WIP" in merge requests

Signed-off-by: Joseph Nuthalapati <njoseph@thoughtworks.com>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
This commit is contained in:
Joseph Nuthalapati 2018-11-28 13:02:53 +05:30 committed by James Valleroy
parent 6dc3fbfb97
commit 640620a0bd
No known key found for this signature in database
GPG Key ID: 77C0C75E7B650808

View File

@ -13,7 +13,7 @@ Naming conventions:
* 'Code change', 'patch', and 'commit' are used interchangeably. * 'Code change', 'patch', and 'commit' are used interchangeably.
* 'Author' and 'contributor' are used interchangeably. * 'Author' and 'contributor' are used interchangeably.
* Git 'log' and 'history' are used interchangeably. * Git 'log' and 'history' are used interchangeably.
* PR - pull request * PR, MR - pull request and merge request, used interchangeably.
* 'Merging' often means 'applying a patch to git history' in a general sense, * 'Merging' often means 'applying a patch to git history' in a general sense,
not literal execution of the command `git merge`. not literal execution of the command `git merge`.
@ -49,6 +49,8 @@ Naming conventions:
to a [Developer Certificate of Origin](http://developercertificate.org/). to a [Developer Certificate of Origin](http://developercertificate.org/).
* If (part of) your code changes were inspired or plainly copied from another * If (part of) your code changes were inspired or plainly copied from another
source, please indicate this in the PR, so the reviewer can handle it. source, please indicate this in the PR, so the reviewer can handle it.
* If your PR is not ready for merging yet, the title of your PR must start with
`WIP:`
* Have fun contributing :) * Have fun contributing :)
@ -82,6 +84,9 @@ Naming conventions:
* In case more fundamental changes are necessary, or if the contributor is new, * In case more fundamental changes are necessary, or if the contributor is new,
try to encourage them to make changes by giving appropriate feedback. This is try to encourage them to make changes by giving appropriate feedback. This is
a major way how we mentor new contributors. a major way how we mentor new contributors.
* Any PR whose title starts with `WIP:` cannot be merged. Communicate with the
author on what the pending changes are. Get the author to complete them or
complete them yourself in case of an emergency.
* Have fun reviewing :) * Have fun reviewing :)