sikkienl/dash
1
0
Fork 0
mirror of https://github.com/dashpay/dash.git synced 2024-12-24 11:32:46 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

style: adjust template of new PR (#5193)

Browse Source 
## 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
This commit is contained in:
Konstantin Akimov 2023-02-13 10:15:23 +07:00 committed by GitHub
parent cf0ec1c32c
commit 11f67cba23
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 24 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
.github/PULL_REQUEST_TEMPLATE.md vendored
View File

@ -1,53 +1,52 @@
<!-- ***Please remove the italicized help prompts before submitting or merging***
*** Please remove the following help text before submitting: ***
Provide a general summary of your changes in the Title above _Provide a general summary of your changes in the Title above_
Pull requests without a rationale and clear improvement may be closed _Pull requests without a rationale and clear improvement may be closed
immediately. immediately._
Please provide clear motivation for your patch and explain how it improves _Please provide clear motivation for your patch and explain how it improves
Dash Core user experience or Dash Core developer experience Dash Core user experience or Dash Core developer experience
significantly: significantly:_
* Any test improvements or new tests that improve coverage are always welcome. * _Any test improvements or new tests that improve coverage are always welcome._
* All other changes should have accompanying unit tests (see `src/test/`) or * _All other changes should have accompanying unit tests (see `src/test/`) or
functional tests (see `test/`). Contributors should note which tests cover functional tests (see `test/`). Contributors should note which tests cover
modified code. If no tests exist for a region of modified code, new tests modified code. If no tests exist for a region of modified code, new tests
should accompany the change. should accompany the change._
* Bug fixes are most welcome when they come with steps to reproduce or an * _Bug fixes are most welcome when they come with steps to reproduce or an
explanation of the potential issue as well as reasoning for the way the bug explanation of the potential issue as well as reasoning for the way the bug
was fixed. was fixed._
* Features are welcome, but might be rejected due to design or scope issues. * _Features are welcome, but might be rejected due to design or scope issues.
If a feature is based on a lot of dependencies, contributors should first If a feature is based on a lot of dependencies, contributors should first
consider building the system outside of Dash Core, if possible. consider building the system outside of Dash Core, if possible._
-->
## Issue being fixed or feature implemented ## Issue being fixed or feature implemented
<!--- Why is this change required? What problem does it solve? --> - _Why is this change required? What problem does it solve?_
<!--- If it fixes an open issue, please link to the issue here. --> - _If it fixes an open issue, please link to the issue here._
## What was done? ## What was done?
<!--- Describe your changes in detail --> _Describe your changes in detail_
## How Has This Been Tested? ## How Has This Been Tested?
<!--- Please describe in detail how you tested your changes. --> _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. --> _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 ## Breaking Changes
<!--- Please describe any breaking changes your code introduces --> _Please describe any breaking changes your code introduces_
## Checklist: ## Checklist:
<!--- Go over all the following points, and put an `x` in all the boxes that apply. --> _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 performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas - [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have added or updated relevant unit/integration/functional/e2e tests - [ ] I have added or updated relevant unit/integration/functional/e2e tests
- [ ] I have made corresponding changes to the documentation - [ ] 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