Skip to content

docs: enhance Definition of Done #239

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
M-Adam-Hus wants to merge 2 commits into
base: beta
Choose a base branch
from
Open

docs: enhance Definition of Done #239

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6686c24
Update pull_request_template.md
M-Adam-Hus Nov 18, 2025
2644882
Update pull_request_template.md
M-Adam-Hus Dec 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 40 additions & 20 deletions .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,40 @@
# 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 `x` to the boxes that are relevant to your changes.

- [ ] I have followed the contribution guidelines for this project
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] 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
Copy link
Copy Markdown
Contributor

@daniel-mader daniel-mader Feb 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.


"Done" means the work is ready for production and considerate of future maintainers. Work is not "done" until:

* **Reviewers** understand *what* was done and *why*.
* **Testers** clearly understand *how* to verify it.
* **Future Developers** can understand the code and its purpose without context switching.
* **The Product** is measurably better.

---

# 2. Pull Request (PR) Template

## Description & Purpose
Please explain the feature and how it furthers the product (technical or business value).

## Changes Made
High-level summary of technical changes.

## Related Issues
## Testing Instructions
Step-by-step instructions for the reviewer to verify the work.

---

# 3. Ready-to-Merge Checklist
Please review your own work and check the following boxes before requesting a review.

### Code Quality
- [ ] Clean Code
- [ ] Clarity

### Testing
- [ ] Coverage
- [ ] Passes
- [ ] Verified

### Documentation
- [ ] Docs
- [ ] Context
Loading