File tree Expand file tree Collapse file tree 1 file changed +49
-0
lines changed
.github/PULL_REQUEST_TEMPLATE Expand file tree Collapse file tree 1 file changed +49
-0
lines changed Original file line number Diff line number Diff line change
1
+ <!--
2
+ Thank you for sending the PR! We appreciate you spending the time to work on
3
+ these changes.
4
+
5
+ Help us understand your motivation by explaining why you decided to make this change.
6
+
7
+ Happy contributing!
8
+
9
+ - Comments should be formatted to a width no greater than 80 columns.
10
+
11
+ - Files should be exempt of trailing spaces.
12
+
13
+ - We adhere to a specific format for commit messages. Please write your commit
14
+ messages along these guidelines. Please keep the line width no greater than 80
15
+ columns (You can use `fmt -n -p -w 80` to accomplish this).
16
+
17
+
18
+ -->
19
+
20
+ ## module-name: One line description of your change (less than 72 characters)
21
+
22
+ ## Problem
23
+
24
+ Explain the context and why you're making that change. What is the problem
25
+ you're trying to solve? In some cases there is not a problem and this can be
26
+ thought of being the motivation for your change.
27
+
28
+ ## Solution
29
+
30
+ Describe the modifications you've done.
31
+
32
+ ## Result
33
+
34
+ What will change as a result of your pull request? Note that sometimes this
35
+ section is unnecessary because it is self-explanatory based on the solution.
36
+
37
+ Some important notes regarding the summary line:
38
+
39
+ - Describe what was done; not the result
40
+ - Use the active voice
41
+ - Use the present tense
42
+ - Capitalize properly
43
+ - Do not end in a period — this is a title/subject
44
+ - Prefix the subject with its scope
45
+
46
+ ## Test Plan
47
+
48
+ (Write your test plan here. If you changed any code, please provide us with
49
+ clear instructions on how you verified your changes work.)
You can’t perform that action at this time.
0 commit comments