diff --git a/.github/workflows/PULL_REQUEST_TEMPLATE.md b/.github/workflows/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..ca839ab51 --- /dev/null +++ b/.github/workflows/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,38 @@ +# Description + +_Please include a summary of the change and which issue is fixed. Provide relevant motivation and context. Ensure that no new external dependencies are introduced in this change._ + +Issue reference: +Related documentation: + +# Implementation Details + +_Provide a detailed description of the implementation. Include the following:_ + +- [ ] Key changes introduced by this PR +- [ ] Justification for the changes +- [ ] Confirmation that no new external dependencies or modules have been introduced + +# Documentation Summary + +- [ ] **Metadata Included:** + _Did you include the metadata (associative arrays) in the code? Ensure that metadata for modules, jobs, and runtime has been updated appropriately._ + +- [ ] **Document Generated:** + _Did you generate the updated documentation using `armbian-configng --doc`? Confirm if the command was run to update `README.md` and provide any relevant details._ + +# Testing Procedure + +_Describe the tests you ran to verify your changes. Provide relevant details about your test configuration._ + +- [ ] Test 1: Description and results +- [ ] Test 2: Description and results + +# Checklist + +- [ ] My code follows the style guidelines of this project +- [ ] I have performed a self-review of my code +- [ ] I have ensured that my changes do not introduce new warnings or errors +- [ ] No new external dependencies are included +- [ ] Changes have been tested and verified +- [ ] I have included necessary metadata in the code, including associative arrays