From 11f67cba2361ef34526e30251ae35d373167c1da Mon Sep 17 00:00:00 2001 From: Konstantin Akimov Date: Mon, 13 Feb 2023 10:15:23 +0700 Subject: [PATCH] style: adjust template of new PR (#5193) ## Issue being fixed or feature implemented Currently template for "New pull request" have a lot of instruction that are formatted as comments by html/markdown tag. It makes this instruction to append in the final commit message when pull request is merged because they are invisible for reviewer (marked as comment). With new template the messages would be more likely to be cleaned up before merging. ## What was done? Replaced commented text in template to cursive test (italic) ## How Has This Been Tested? By clicking "Preview" on GitHub ## Breaking Changes No breaking changes, it's trivial change ## Checklist: - [x] I have performed a self-review of my own code - [x] I have assigned this pull request to a milestone --- .github/PULL_REQUEST_TEMPLATE.md | 49 ++++++++++++++++---------------- 1 file changed, 24 insertions(+), 25 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index b86605a673..b1fbc8e0f2 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,53 +1,52 @@ - + consider building the system outside of Dash Core, if possible._ + ## Issue being fixed or feature implemented - - + - _Why is this change required? What problem does it solve?_ + - _If it fixes an open issue, please link to the issue here._ ## What was done? - + _Describe your changes in detail_ ## How Has This Been Tested? - - - + _Please describe in detail how you tested your changes._ + + _Include details of your testing environment, and the tests you ran +to see how your change affects other areas of the code, etc._ ## Breaking Changes - + _Please describe any breaking changes your code introduces_ ## Checklist: - + _Go over all the following points, and put an `x` in all the boxes that apply._ - [ ] I have performed a self-review of my own code - [ ] I have commented my code, particularly in hard-to-understand areas - [ ] I have added or updated relevant unit/integration/functional/e2e tests - [ ] I have made corresponding changes to the documentation +- [ ] I have assigned this pull request to a milestone _(for repository code-owners and collaborators only)_ -**For repository code-owners and collaborators only** -- [ ] I have assigned this pull request to a milestone