Extend PR template when asking for documentation
This commit is contained in:
parent
977018b2e5
commit
5053423925
19
.github/PULL_REQUEST_TEMPLATE.md
vendored
19
.github/PULL_REQUEST_TEMPLATE.md
vendored
@ -1,21 +1,32 @@
|
||||
# Description
|
||||
|
||||
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
|
||||
_Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change._
|
||||
|
||||
Jira reference number [AR-9999]
|
||||
[Jira](https://armbian.atlassian.net/jira) reference number [AR-9999]
|
||||
|
||||
# Documentation summary for feature / change
|
||||
|
||||
_Please delete this section if entry to main documentation is not needed._
|
||||
|
||||
If documentation entry is predicted, please provide key elements for further implementation [into main documentation](https://docs.armbian.com) and set label to "Needs Documentation". You are welcome to open a PR to documentation or you can leave following information for technical writer:
|
||||
|
||||
- [ ] short description (copy / paste of PR title)
|
||||
- [ ] summary (description relevant for end users)
|
||||
- [ ] example of usage (how to see this in function)
|
||||
|
||||
# How Has This Been Tested?
|
||||
|
||||
Please describe the tests that you ran to verify your changes. Please also note any relevant details for your test configuration.
|
||||
_Please describe the tests that you ran to verify your changes. Please also note any relevant details for your test configuration._
|
||||
|
||||
- [ ] Test A
|
||||
- [ ] Test B
|
||||
|
||||
# Checklist:
|
||||
|
||||
_Please delete options that are not relevant._
|
||||
|
||||
- [ ] My code follows the style guidelines of this project
|
||||
- [ ] I have performed a self-review of my own code
|
||||
- [ ] I have commented my code, particularly in hard-to-understand areas
|
||||
- [ ] I have made corresponding changes to the documentation
|
||||
- [ ] My changes generate no new warnings
|
||||
- [ ] Any dependent changes have been merged and published in downstream modules
|
||||
|
||||
Loading…
Reference in New Issue
Block a user