Skip to content

docs: fix typos DOD.md #1101

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
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: fix typos DOD.md #1101

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1097b5c
fix typos DOD.md
osrm Jan 7, 2025
a0776c8
Merge branch 'permaweb:main' into dod-fix
osrm Jan 23, 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
10 changes: 5 additions & 5 deletions DOD.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Defintion of Delivery
# Definition of Delivery

The Definition of Delivery or definition of done is provide to give developers
on direction of what is required to deliver a issue. It also helps code
The Definition of Delivery or definition of done is provided to give developers
on direction of what is required to deliver an issue. It also helps code
reviewers with what to review when reviewing an issue.

The three core concepts that all issues should contain for developers are:
Expand All @@ -17,7 +17,7 @@ Some critical requirements for a definition of done:

By using stratified design and clean architecture concepts we can cleanly
separate logic from side effects, this provides us the ability to write unit and
integration tests that delivery high effectiveness at a low implementation cost.
integration tests that deliver high effectiveness at a low implementation cost.

2. Technical Documentation explaining the usability of the feature.

Expand Down Expand Up @@ -45,5 +45,5 @@ Does the code accomplish the issue?

Is there automated tests that reliably verify any logic added to the delivery?

Is there enough documentation to satify my future self (or someone else?) to
Is there enough documentation to satisfy my future self (or someone else?) to
maintain this issue?