From 5053423925c98f4d574d2d606b961476fe625661 Mon Sep 17 00:00:00 2001 From: Igor Pecovnik Date: Mon, 11 Mar 2024 15:35:27 +0100 Subject: [PATCH] Extend PR template when asking for documentation --- .github/PULL_REQUEST_TEMPLATE.md | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index bca6d1adfd..4efe99bf16 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -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