-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
20 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
Commit Message Parser | ||
====================== | ||
|
||
Overview | ||
-------- | ||
The commit message parser is designed to extract and organize commit message components into a structured format. It identifies the summary, body, and footer from commit messages that follow common conventions. | ||
|
||
Features | ||
-------- | ||
The commit parser offers several key features. First, it performs summary extraction by capturing the first line of the commit message and designating it as the summary. | ||
|
||
Next, it includes body extraction, which collects all lines that follow the summary while excluding any footer lines. | ||
|
||
In addition, the parser recognizes and collects footer lines, accommodating special tags such as “BREAKING CHANGE” as well as any user-defined footer labels. | ||
|
||
Moreover, the parser effectively handles whitespace, preserving leading and trailing whitespace and newlines to maintain the original formatting of the commit message. | ||
|
||
Finally, it incorporates error handling by raising a ValueError when an empty commit message is provided, thus preventing potential processing errors. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters