unifi-docker/.github/PULL_REQUEST_TEMPLATE.md

29 lines
1.2 KiB
Markdown

Use a prefix like [TASK], [BUGFIX], [DOC] or [CGL] and provide a general summary of your changes in the Title above.
**IMPORTANT: Please do not create a Pull Request without creating an issue first.**
*Any change needs to be discussed before proceeding. Failure to do so may result in the rejection of the pull request.*
Please provide enough information so that others can review your pull request:
## Description
Explain the **details** for making this change. What existing problem does the pull request solve?
## Motivation and Context
Why is this change required? What problem does it solve?
## How Has This Been Tested?
Demonstrate the code is solid. Example: The exact commands you ran and their output, screenshots / videos if the pull request changes UI.
## Closing issues
Put `closes #XXXX` in your comment to auto-close the issue that your PR fixes (if such).
## Checklist:
Go over all the following points, and put an `x` in all the boxes that apply.
If you're unsure about any of these, don't hesitate to ask. We're here to help!
- [ ] My code follows the code style of this project. (CI will test it anyway and also needs approval)
- [ ] My change requires a change to the documentation.
- [ ] I have updated the documentation accordingly.