[github] Updated pull request template
authorGeunsik Lim <geunsik.lim@samsung.com>
Tue, 3 Jul 2018 10:58:31 +0000 (19:58 +0900)
committer함명주/동작제어Lab(SR)/Principal Engineer/삼성전자 <myungjoo.ham@samsung.com>
Wed, 4 Jul 2018 00:54:14 +0000 (09:54 +0900)
This PR is to update the existing pull request (PR) template
in order that developers can write a good Git commit messages.

**Changed proposed in this PR:**
1. Updated PR template

Signed-off-by: Geunsik Lim <geunsik.lim@samsung.com>
.github/PULL_REQUEST_TEMPLATE.md

index 77d7cdd..c8de5db 100644 (file)
@@ -1,19 +1,40 @@
+
+---
 # [Template] PR Description
-github.sec.samsung.net automatically copies your commit message for your convenience.
-Please write your own PR description with this template and remove unused part of the template.
 
-Fixed issue #no.
-Depict why this PR has to be merged into the mainline repository.
+In general, github system automatically copies your commit message for your convenience.
+Please remove unused part of the template after writing your own PR description with this template.
+```bash
+$ git commit -s filename1 filename2 ... [enter]
+
+Summarize changes in around 50 characters or less
+
+More detailed explanatory text, if necessary. Wrap it to about 72
+characters or so. In some contexts, the first line is treated as the
+subject of the commit and the rest of the text as the body. The
+blank line separating the summary from the body is critical;
+various tools like `log`, `shortlog` and `rebase` can get confused 
+if you run the two together.
+
+Further paragraphs come after blank lines.
 
 **Changes proposed in this PR:**
-1. Write 1st content
-2. Write 2nd content
+- Bullet points are okay, too
+- Typically a hyphen or asterisk is used for the bullet, preceded
+  by a single space, with blank lines in between, but conventions vary here.
+
+Resolves: #123
+See also: #456, #789
 
 **Self evaluation:**
-1. Build test: [ ]Passed [ ]Failed [ ]Skipped
+1. Build test: [ ]Passed [ ]Failed [*]Skipped
 2. Run test: [ ]Passed [ ]Failed [* ]Skipped
 
 **How to evaluate:**
-1. Describe how to evaluate your PR.
+1. Describe how to evaluate in order to be reproduced by reviewer(s).
+
+Add signed-off message automatically by running **$git commit -s ...** command.
+
+$ git push origin <your_branch_name>
+```
 
-Append signed-off information by running **$git commit -s ...** command.