Git Commit Reader #46
Open
Conversation
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
3 tasks
mariugul
force-pushed
the
feat/git-commit-reader
branch
from
c0ec998
to
862e212
Compare
Uses the new implementation of the parse_commit_message() method which implements parsing a commit into SUMMARY, BODY and FOOTER.
Created commit_reader.py which has methods to read commits from a git repo.
mariugul
force-pushed
the
feat/git-commit-reader
branch
from
862e212
to
c9c3f9f
Compare
Wrote tests creating actual git repos with commits and testing the commit reader methods.
mariugul
force-pushed
the
feat/git-commit-reader
branch
from
c9c3f9f
to
f654374
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Commit Reader
PR Description: Implement Commit Reader and Improve Commit Parsing
This PR introduces several enhancements and new features focused on reading and parsing Git commits more effectively:
Key Changes:
Refactor parse_commit_message():
The parse_commit_message() method has been refactored to improve commit parsing. It now breaks down a commit message into SUMMARY, BODY, and FOOTER components, providing better structure and readability.
New Commit Reader (commit_reader.py):
A new module commit_reader.py has been added, which includes methods to read commits directly from a Git repository. This allows for more flexible and automated commit retrieval for further processing.
Unit Tests for Commit Reader:
Unit tests have been written to ensure the functionality of the commit reader. These tests create actual Git repositories with commits, validating that the commit reader works as expected in real-world scenarios.
Documentation:
Comprehensive documentation has been added for the new commit reader, detailing its usage and the new commit parsing logic.
Benefits:
Enhanced commit parsing logic provides more structured commit data for further analysis.
The new commit reader improves automation by allowing Git commits to be read directly from repositories.
Extensive unit testing ensures the robustness and reliability of the new features.
This PR refines the system for working with Git commits, laying the foundation for future improvements.
Closing #45