File tree Expand file tree Collapse file tree 1 file changed +2
-2
lines changed Expand file tree Collapse file tree 1 file changed +2
-2
lines changed Original file line number Diff line number Diff line change @@ -239,10 +239,10 @@ for basics.
239239 merged commit, so it needs to be useful in the output of ` git log ` .
240240 - Bad title: "Fix a bug"
241241 - Good title: "Add XYZ method to ABC"
242- - Give the PR a clear and thorough description . Don't just describe what the PR
242+ - In the "Summary" section, clearly and thoroughly describe the intent of the PR . Don't just describe what the PR
243243 does: the diff will do that. Explain * why* you are making this change, in a
244244 way that will make sense to someone years from now.
245- - Explain how you have tested your changes by including repeatable instructions for
245+ - In the "Test plan" section, explain how you have tested your changes by including repeatable instructions for
246246 testing the PR.
247247 - If you added tests, this can be as simple as the command you used to run the
248248 tests.
You can’t perform that action at this time.
0 commit comments