Open
Conversation
Updating the pull request template to align with a new 'Definition of Done'. Key changes include: - Added a mandatory 'Purpose' section to explain the 'why'. - Added specific instructions for testing steps. - Updated the checklist to be more engaging and focused on code quality and self-review.
M-Adam-Hus
requested review from
daniel-mader and
nanderstabel
as code owners
M-Adam-Hus
changed the title
daniel-mader
requested changes
Feb 26, 2026
| - [ ] I have added tests that prove my fix is effective or that my feature works | ||
| - [ ] New and existing unit tests pass locally with my changes | ||
| - [ ] I have successfully tested this change in a docker environment | ||
| # 1. The Principle: Definition of Done |
Contributor
There was a problem hiding this comment.
The proposed changes read a little "generated". I also feel like it's a lot of prose which is reasoning about why we need a DoD, which I think can stay in it's previous form as a simple check list. I think we can highlight the key point in each bullet point in bold, so it's even clearer. I'd rather go the route of educating frequent contributors than to bloat this document.
Also, your proposed changes remove the key point of "linking relevant issues".
I understand why you opened this PR, but I think the proposed changes are not covering that intent yet.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Updating the pull request template to align with a new 'Definition of Done'.
Key changes include:
Description of change
Please write a summary of your changes and why you made them.
Links to any relevant issues
Be sure to reference any related issues by adding
fixes issue #.How the change has been tested
Describe the tests that you ran to verify your changes.
Make sure to provide instructions for the maintainer as well as any relevant configurations.
Definition of Done checklist
Add an
xto the boxes that are relevant to your changes.