Skip to content
This repository was archived by the owner on Aug 11, 2025. It is now read-only.

Commit 27b36d6

Browse files
authored
feat(docs): create .dod.yml
Creating the dod file that will be used as an example while developing this tool
1 parent 031f3aa commit 27b36d6

1 file changed

Lines changed: 38 additions & 0 deletions

File tree

.dod.yml

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# -----------------------------------------------------------------------------
2+
# .dod.yml - Definition of Done Checklist for the 'check-commit' tool
3+
#
4+
# This file defines the interactive checklist that runs before a commit.
5+
# The goal is to create a lightweight, fast quality gate that reinforces
6+
# team standards without being obtrusive.
7+
#
8+
# Instructions:
9+
# - Keep the active list short and focused (3-5 items is ideal).
10+
# - Comment out items that are better handled by automated CI or are too
11+
# time-consuming for a developer to verify on every single commit.
12+
# -----------------------------------------------------------------------------
13+
14+
# --- Optional Issue Tracker Integration ---
15+
# If true, the check-commit tool will require the --issue <ID> flag
16+
# to be used with the commit command, ensuring all work is traceable.
17+
issue_reference_required: true
18+
19+
checklist:
20+
# --- Code Quality & Testing (High-Impact Checks) ---
21+
- "Code is clean, readable, and adheres to team coding standards."
22+
- "All relevant automated tests (unit, integration) pass successfully."
23+
- "New features or bug fixes are covered by appropriate new tests."
24+
25+
# --- Security & Documentation (Important Reminders) ---
26+
- "Security implications of this change have been considered."
27+
- "Relevant documentation (code comments, READMEs, etc.) is updated."
28+
29+
# --- Advanced / CI-Handled Checks (Commented out by default) ---
30+
# These are critical but are often better verified automatically in a CI pipeline
31+
# or are too in-depth for a quick pre-commit check.
32+
33+
# - "[Resilience] The system design considers potential failure scenarios."
34+
# - "[Observability] Necessary logging, metrics, and monitoring hooks are in place."
35+
# - "[Deployability] The change is independently deployable and testable."
36+
# - "[Architecture] The change adheres to a loosely coupled architecture."
37+
# - "[Compliance] The change is cyber secure and privacy compliant."
38+
# - "[Test Data] Required test data is available and follows policies."

0 commit comments

Comments
 (0)