Skip to content

Commit 066b92f

Browse files
authored
Merge pull request #575 from GoekeLab/devel_pre
Update bambu pr template
2 parents b5811e3 + a445dcf commit 066b92f

File tree

1 file changed

+18
-6
lines changed

1 file changed

+18
-6
lines changed

.github/pull_request_template.md

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
1+
*Remove unused sections before submitting. Only keep what is relevant.*
2+
3+
*Text marked with `<!-- Text here -->` will not be rendered*
4+
15
## Related Issue
2-
Fixes # (issue number)
6+
<!-- e.g. Fixes #<issue_number> -->
37

48
## Type of Change
59
- [ ] **Bug fix** (non-breaking change which fixes an issue)
@@ -10,21 +14,29 @@ Fixes # (issue number)
1014
- [ ] **Performance optimization**
1115

1216
## Description
13-
Please provide a summary and the motivation for the changes. Why is this change necessary? What problem does it solve?
17+
<!-- Please provide a summary and the motivation for the changes. Why is this change necessary? What problem does it solve? -->
1418

1519
## Implementation Details
16-
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.
20+
<!-- 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. -->
1721

1822
## Impact of Changes
19-
Briefly describe the impact of the implemented changes. For example:
23+
<!-- Briefly describe the impact of the implemented changes. For example:
2024
- Results are identical to the previous version.
2125
- Bug fix only (no changes to output).
2226
- Adds one column to the SE object.
23-
- Transcript quantification results show minimal differences.
27+
- Transcript quantification results show minimal differences. -->
2428

2529
## Checklist
2630
- [ ] My code follows the style guidelines of this project.
2731
- [ ] I have performed a self-review of my own code.
32+
- [ ] I have verified that GitHub automated tests passed. (Describe any failing tests in the next section)
2833
- [ ] I have commented my code, particularly in hard-to-understand areas.
2934
- [ ] I have made corresponding changes to the documentation (vignettes, man pages).
30-
- [ ] I have tested the code on a full dataset, and any differences have been described in the Impact of Changes section.
35+
- [ ] I have tested the code on a full dataset, and any differences have been described in the pull request.
36+
37+
## Post-merge follow-up
38+
<!-- Describe any remaining work to be done after the pull request has been merged. For example,
39+
- Github automated tests did not pass in the original branch; this will be fixed separately.
40+
- Unit tests for a(), b() will fail due to intentional code changes; tests will be updated post-review.
41+
- README documentation has not been updated to depict the functionality changes to the PR; will be updated post-review.
42+
- Known bugs to be fixed in a follow-up issue — #TODO comments added in affected code. -->

0 commit comments

Comments
 (0)