]> git.proxmox.com Git - mirror_zfs.git/blob - .github/PULL_REQUEST_TEMPLATE.md
PR's should provide motivation & context first
[mirror_zfs.git] / .github / PULL_REQUEST_TEMPLATE.md
1 <!--- Provide a general summary of your changes in the Title above -->
2
3 <!---
4 Documentation on ZFS Buildbot options can be found at
5 https://github.com/zfsonlinux/zfs/wiki/Buildbot-Options
6 -->
7
8 ### Motivation and Context
9 <!--- Why is this change required? What problem does it solve? -->
10 <!--- If it fixes an open issue, please link to the issue here. -->
11
12 ### Description
13 <!--- Describe your changes in detail -->
14
15 ### How Has This Been Tested?
16 <!--- Please describe in detail how you tested your changes. -->
17 <!--- Include details of your testing environment, and the tests you ran to -->
18 <!--- see how your change affects other areas of the code, etc. -->
19 <!--- If your change is a performance enhancement, please provide benchmarks here. -->
20
21 ### Types of changes
22 <!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
23 - [ ] Bug fix (non-breaking change which fixes an issue)
24 - [ ] New feature (non-breaking change which adds functionality)
25 - [ ] Performance enhancement (non-breaking change which improves efficiency)
26 - [ ] Code cleanup (non-breaking change which makes code smaller or more readable)
27 - [ ] Breaking change (fix or feature that would cause existing functionality to change)
28 - [ ] Documentation (a change to man pages or other documentation)
29
30 ### Checklist:
31 <!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
32 <!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
33 - [ ] My code follows the ZFS on Linux [code style requirements](https://github.com/zfsonlinux/zfs/blob/master/.github/CONTRIBUTING.md#coding-conventions).
34 - [ ] I have updated the documentation accordingly.
35 - [ ] I have read the [**contributing** document](https://github.com/zfsonlinux/zfs/blob/master/.github/CONTRIBUTING.md).
36 - [ ] I have added [tests](https://github.com/zfsonlinux/zfs/tree/master/tests) to cover my changes.
37 - [ ] All new and existing tests passed.
38 - [ ] All commit messages are properly formatted and contain [`Signed-off-by`](https://github.com/zfsonlinux/zfs/blob/master/.github/CONTRIBUTING.md#signed-off-by).
39 - [ ] Change has been approved by a ZFS on Linux member.