From 5a8ae4229872ce9f46d598fa8614eb0b3d27d3a3 Mon Sep 17 00:00:00 2001 From: S4NKALP Date: Wed, 4 Jun 2025 13:39:09 +0545 Subject: [PATCH] =?UTF-8?q?=F0=9F=94=A7=20chore(devtools/commitgen/generat?= =?UTF-8?q?or.py):=20Clean=20up=20user=20prompt=20text=20in=20commit=20mes?= =?UTF-8?q?sage=20generation?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CHANGELOG.md | 45 +++++++++++++++++++++++---------- devtools/commitgen/generator.py | 3 ++- 2 files changed, 34 insertions(+), 14 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index de973b8..c7fa87e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,32 +2,51 @@ ## 0.1.0 -### Added +Changes for version 0.1.0: -* ✨ docs(changelog): Add ChangelogGenerator class documentation +🔧 Maintenance: + +- Cleaned up user prompt text in commit message generation +- Updated commit message and changelog generation using AI 👨‍💻 +- Removed unused variable in `_run_git_command` calls 🗑️ +- Updated `GitService` to return exit code from `_run_git_command` and improved `get_commit_history` method signature and docstring 📝 +- Updated changelog format for clarity and consistency 📚 + +📝 Documentation: + +- Updated changelog format and added ChangelogGenerator class documentation 📚 +- Updated `README.md` file with the new commit message format and ChangelogGenerator class usage 📝 + +Initial: + +- Updated `LICENSE` 📄 +- Initial commit 🚀 + +## Added + +- ✨ docs(changelog): Add ChangelogGenerator class documentation ### Changed -* 🔄 refactor(generator): Update commit message and changelog generation using AI -* 🔄 refactor(git.py): Remove unused variable in `_run_git_command` calls -* 🔄 refactor(devtools/shared/git.py): Update GitService to return exit code from `_run_git_command` and improve `get_commit_history` method signature and docstring -* 🔄 docs(changelog): Updated changelog format for clarity and consistency +- 🔄 refactor(generator): Update commit message and changelog generation using AI +- 🔄 refactor(git.py): Remove unused variable in `_run_git_command` calls +- 🔄 refactor(devtools/shared/git.py): Update GitService to return exit code from `_run_git_command` and improve `get_commit_history` method signature and docstring +- 🔄 docs(changelog): Updated changelog format for clarity and consistency ### Fixed -* 🐛 docs(changelog): Updated changelog format and added ChangelogGenerator class documentation +- 🐛 docs(changelog): Updated changelog format and added ChangelogGenerator class documentation ### Initial Commits -* 🚀 Initial commit -* 📚 Update `README.md` file -* 📚 Update `LICENSE` +- 🚀 Initial commit +- 📚 Update `README.md` file +- 📚 Update `LICENSE` ### Removed -* 🗑️ Not applicable for this version +- 🗑️ Not applicable for this version ### Security -* 🔒 Not applicable for this version - +- 🔒 Not applicable for this version diff --git a/devtools/commitgen/generator.py b/devtools/commitgen/generator.py index de4f000..973eaec 100644 --- a/devtools/commitgen/generator.py +++ b/devtools/commitgen/generator.py @@ -35,7 +35,8 @@ class CommitGenerator(AIService): - chore: 🔧 (maintenance tasks, dependencies, etc) 4. Guidelines: - - Keep the description under 73 characters + - Write the ENTIRE message on a single line + - Keep the message concise and to the point - Use imperative mood ("add" not "added") - Don't end with a period - Focus on the "why" not the "what"