X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=.github%2FPULL_REQUEST_TEMPLATE.md;h=e9760193f69b4abba280c3ea6f1910729b515e12;hb=d1d2bcec61c334aa62e388af0a8f1dc499c4fc3b;hp=85e7f8f59d2d9d1434aa723b4f22a59f1c7a562f;hpb=18a3fc9e5548ef6333a8bb28551dd1debe274c8a;p=civicrm-core.git diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 85e7f8f59d..e9760193f6 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,18 +1,20 @@ Overview ---------------------------------------- -_A brief description of the pull request. Try to keep it non-technical._ +_A brief description of the pull request. Keep technical jargon to a minimum. Hyperlink relevant discussions._ Before ---------------------------------------- -_The current status. Please provide screenshots or gifs ([LICEcap](http://www.cockos.com/licecap/), [SilentCast](https://github.com/colinkeenan/silentcast)) where appropriate._ +_What is the old user-interface or technical-contract (as appropriate)?_ +_For optimal clarity, include a concrete example such as a screenshot, GIF ([LICEcap](http://www.cockos.com/licecap/), [SilentCast](https://github.com/colinkeenan/silentcast)), or code-snippet._ After ---------------------------------------- -_What has been changed. Please provide screenshots or gifs ([LICEcap](http://www.cockos.com/licecap/), [SilentCast](https://github.com/colinkeenan/silentcast)) where appropriate._ +_What changed? What is new old user-interface or technical-contract?_ +_For optimal clarity, include a concrete example such as a screenshot, GIF ([LICEcap](http://www.cockos.com/licecap/), [SilentCast](https://github.com/colinkeenan/silentcast)), or code-snippet._ Technical Details ---------------------------------------- -_If the PR introduces noteworthy technical changes, please describe them here. Provide code snippets if necessary_ +_If the PR involves technical details/changes/considerations which would not be manifest to a casual developer skimming the above sections, please describe the details here._ Comments ----------------------------------------