From 4e390394a995e00f8599cfef5458c909fe7fea66 Mon Sep 17 00:00:00 2001 From: KaySar12 Date: Tue, 13 May 2025 19:07:44 +0700 Subject: [PATCH] docs(scripts/interpreter): update commit convention document --- scripts/interpreter/commit_convention.txt | 141 ++++++---------------- 1 file changed, 38 insertions(+), 103 deletions(-) diff --git a/scripts/interpreter/commit_convention.txt b/scripts/interpreter/commit_convention.txt index 9ad9d2f..f8765dc 100644 --- a/scripts/interpreter/commit_convention.txt +++ b/scripts/interpreter/commit_convention.txt @@ -1,115 +1,50 @@ -Conventional Commits 1.0.0 -Summary -The Conventional Commits specification is a lightweight convention on top of commit messages. It provides an easy set of rules for creating an explicit commit history; which makes it easier to write automated tools on top of. This convention dovetails with SemVer, by describing the features, fixes, and breaking changes made in commit messages. +Git Commit Guidelines +Git Commit +This documented was extracted from Contributing to AngularJS. Every contributor to the project should be aware of the following rules. -The commit message should be structured as follows: +We have very precise rules over how our git commit messages can be formatted. This leads to more readable messages that are easy to follow when looking through the project history. But also, we use the git commit messages to generate the theme framework change log. -[optional scope]: +The commit message formatting can be added using a typical git workflow or through the use of a CLI wizard (Commitizen). To use the wizard, run npm run commit in your terminal after staging your changes in git. -[optional body] +Commit Message Format +Each commit message consists of a header, a body and a footer. The header has a special format that includes a type, a scope and a subject: -[optional footer(s)] -The commit contains the following structural elements, to communicate intent to the consumers of your library: +(): + + + +