From 5967af91300ad4869667e9b29680389c6dca9ac6 Mon Sep 17 00:00:00 2001 From: lingminhao Date: Mon, 20 Apr 2026 14:33:27 +0800 Subject: [PATCH 1/3] update bambu pr template --- .github/pull_request_template.md | 35 ++++++++++++++++++++------------ 1 file changed, 22 insertions(+), 13 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 3a478a10..8218ca9e 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,30 +1,39 @@ -## Related Issue -Fixes # (issue number) +*Remove unused sections before submitting. Only keep what is relevant.* -## Type of Change +## *Related Issue* +Fixes # + +## *Type of Change* - [ ] **Bug fix** (non-breaking change which fixes an issue) -- [ ] **New feature** (please specify if the change breaks existing functionality) - - [ ] **Non breaking change** (the feature doesn't change existing functionality) - - [ ] **Breaking change** (the feature that would cause existing functionality to not work as expected) +- [ ] **Breaking change** (fix or feature that would cause existing functionality to not work as expected) +- [ ] **New feature** (non-breaking change which adds functionality) - [ ] **Documentation update** - [ ] **Performance optimization** -## Description +## *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. +## *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` — refer to the package's main function arguments) 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: +## *Impact of Changes* +Briefly describe the impact of the implemented changes. For example: - Results are identical to the previous version. - Bug fix only (no changes to output). - Adds one column to the SE object. - Transcript quantification results show minimal differences. -## Checklist +## *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* +Describe any remaining work to be done after the pull request has been merged. For example, +- Github automated tests did not pass in the original branch; this will be fixed separately. +- Unit tests for a(), b() will fail due to intentional code changes; tests will be updated post-review. +- README documentation has not been updated to depict the functionality changes to the PR; will be updated post-review. +- Known bugs to be fixed in a follow-up issue — #TODO comments added in affected code. \ No newline at end of file From 129559a8de5d002fc313203d1b790d8f1a9464a0 Mon Sep 17 00:00:00 2001 From: lingminhao Date: Mon, 20 Apr 2026 14:39:16 +0800 Subject: [PATCH 2/3] update bambu pr template --- .github/pull_request_template.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 8218ca9e..8c6d2297 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -5,8 +5,9 @@ Fixes # ## *Type of Change* - [ ] **Bug fix** (non-breaking change which fixes an issue) -- [ ] **Breaking change** (fix or feature that would cause existing functionality to not work as expected) -- [ ] **New feature** (non-breaking change which adds functionality) +- [ ] **New feature** (please specify if the change breaks existing functionality) + - [ ] **Non breaking change** (the feature doesn't change existing functionality) + - [ ] **Breaking change** (the feature that would cause existing functionality to not work as expected) - [ ] **Documentation update** - [ ] **Performance optimization** From 48017de0739a39c2dc170c97a0ee029769a713d4 Mon Sep 17 00:00:00 2001 From: lingminhao Date: Mon, 20 Apr 2026 15:17:28 +0800 Subject: [PATCH 3/3] update bambu pr template --- .github/pull_request_template.md | 30 ++++++++++++++++-------------- 1 file changed, 16 insertions(+), 14 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 8c6d2297..abbce8f6 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,9 +1,11 @@ *Remove unused sections before submitting. Only keep what is relevant.* -## *Related Issue* -Fixes # +*Text marked with `` will not be rendered* -## *Type of Change* +## Related Issue + + +## Type of Change - [ ] **Bug fix** (non-breaking change which fixes an issue) - [ ] **New feature** (please specify if the change breaks existing functionality) - [ ] **Non breaking change** (the feature doesn't change existing functionality) @@ -11,20 +13,20 @@ Fixes # - [ ] **Documentation update** - [ ] **Performance optimization** -## *Description* -Please provide a summary and the motivation for the changes. Why is this change necessary? What problem does it solve? +## Description + -## *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` — refer to the package's main function arguments) are affected? Include relevant technical details for any algorithmic changes or data structure modifications specific to Bambu. +## Implementation Details + -## *Impact of Changes* -Briefly describe the impact of the implemented changes. For example: +## Impact of Changes + -## *Checklist* +## 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) @@ -32,9 +34,9 @@ Briefly describe the impact of the implemented changes. For example: - [ ] 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 pull request. -## *Post-merge follow-up* -Describe any remaining work to be done after the pull request has been merged. For example, +## Post-merge follow-up + \ No newline at end of file