dash/.github/PULL_REQUEST_TEMPLATE.md

53 lines
2.1 KiB
Markdown
Raw Normal View History

***Please remove the italicized help prompts before submitting or merging***
_Provide a general summary of your changes in the Title above_
2021-10-13 16:49:37 +02:00
_Pull requests without a rationale and clear improvement may be closed
immediately._
_Please provide clear motivation for your patch and explain how it improves
Dash Core user experience or Dash Core developer experience
significantly:_
* _Any test improvements or new tests that improve coverage are always welcome._
* _All other changes should have accompanying unit tests (see `src/test/`) or
functional tests (see `test/`). Contributors should note which tests cover
modified code. If no tests exist for a region of modified code, new tests
should accompany the change._
* _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
was fixed._
* _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
consider building the system outside of Dash Core, if possible._
2021-10-13 16:49:37 +02:00
## 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._
2021-10-13 16:49:37 +02:00
## What was done?
_Describe your changes in detail_
2021-10-13 16:49:37 +02:00
## 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._
2021-10-13 16:49:37 +02:00
## Breaking Changes
_Please describe any breaking changes your code introduces_
2021-10-13 16:49:37 +02:00
## Checklist:
_Go over all the following points, and put an `x` in all the boxes that apply._
2021-10-13 16:49:37 +02:00
- [ ] 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)_
2021-10-13 16:49:37 +02:00