diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 3a478a10..abbce8f6 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,5 +1,9 @@ +*Remove unused sections before submitting. Only keep what is relevant.* + +*Text marked with `` will not be rendered* + ## Related Issue -Fixes # (issue number) + ## Type of Change - [ ] **Bug fix** (non-breaking change which fixes an issue) @@ -10,21 +14,29 @@ Fixes # (issue number) - [ ] **Performance optimization** ## Description -Please provide a summary and the motivation for the changes. Why is this change necessary? What problem does it solve? + ## Implementation Details -Briefly describe how the changes were implemented. Which specific code segments or logic paths within the primary functional arguments (e.g., `demultiplexed`, `discovery`, `quant`) are affected? Include relevant technical details for any algorithmic changes or data structure modifications specific to Bambu. + ## Impact of Changes -Briefly describe the impact of the implemented changes. For example: + ## Checklist - [ ] My code follows the style guidelines of this project. - [ ] I have performed a self-review of my own code. +- [ ] I have verified that GitHub automated tests passed. (Describe any failing tests in the next section) - [ ] I have commented my code, particularly in hard-to-understand areas. - [ ] I have made corresponding changes to the documentation (vignettes, man pages). -- [ ] I have tested the code on a full dataset, and any differences have been described in the Impact of Changes section. \ No newline at end of file +- [ ] I have tested the code on a full dataset, and any differences have been described in the pull request. + +## Post-merge follow-up + \ No newline at end of file