Skip to content
This repository was archived by the owner on Jul 1, 2025. It is now read-only.

Commit 0239ff3

Browse files
jfix71facebook-github-bot
authored andcommitted
Update PR Template for better Phabricator parsing
Summary: Pull Request resolved: #2916 Differential Revision: D15349297 Pulled By: jfix71 fbshipit-source-id: 460a7a17f32fd7fad01ca77453d7d8ee0773e252
1 parent 902bc9a commit 0239ff3

File tree

2 files changed

+10
-8
lines changed

2 files changed

+10
-8
lines changed

PULL_REQUEST.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,19 +9,19 @@ For example:
99

1010
Ideally, the same format should be used in the commit message.
1111

12-
# Description
12+
# Summary
1313

14-
The description field should include a more verbose explanation of what this PR does.
14+
The Summary field should include a more verbose explanation of what this PR does.
1515
If this PR causes a change in behavior it should document the behavior before and after.
1616
If it fixes a bug, please, describe what the original issue is and how the change resolves it.
1717

1818
# Formatting
1919

2020
Please, run clang-format before submitting the PR.
2121

22-
# Testing
22+
# Test Plan
2323

24-
The testing section should include an explanation of what testing was done.
24+
The test plan section should include an explanation of what testing was done.
2525
For example unit test, manual testing through stand-alone testing binaries like mnist, cifar10, etc.
2626
Please use your best judgment or ask for guidance if you are unsure what kind of testing is required for a given change.
2727
The riskier the change, the more comprehensive the testing should be.
@@ -41,4 +41,3 @@ This way Github will make sure that underlying referenced issue will be automati
4141

4242
If the purpose of the PR to address issue partially, please, just tag the issue:
4343
* #Issue.
44-

PULL_REQUEST_TEMPLATE.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
1-
*Description*:
2-
*Testing*:
3-
*Documentation*:
1+
Summary:
2+
3+
Documentation:
4+
5+
Test Plan:
6+
47
[Optional Fixes #issue]
58

69
Please see a detailed explanation of how to fill out the fields in the relevant sections in PULL_REQUEST.md.

0 commit comments

Comments
 (0)