Skip to content

Commit e1ac5ae

Browse files
committed
docs(meta): document correct format for commit 5827b78
Added note explaining what the conventional commit format should have been for the previous README enhancement commit. This serves as documentation and guidance for maintaining proper commit message standards.
1 parent 9e34189 commit e1ac5ae

1 file changed

Lines changed: 17 additions & 0 deletions

File tree

.github/COMMIT_HISTORY_NOTE.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Commit History Note
2+
3+
## Commit 5827b78
4+
5+
The commit `5827b78a46e74d34111955ec815b84c5a31fa34f` with message:
6+
"Enhance README with project details and structure"
7+
8+
Should have followed conventional commit format as:
9+
```
10+
docs(readme): add comprehensive project documentation
11+
12+
Added detailed sections covering project overview, vision, goals, features,
13+
tech stack, architecture, testing guidelines, and contribution workflow.
14+
```
15+
16+
This note documents the correct format for reference. Future commits will follow
17+
the conventional commit specification as enforced by commitlint.

0 commit comments

Comments
 (0)