Sourcesage

tag3.1.0

概要

新機能

- コミットメッセージのフォーマットとタイプの説明を追加
- タイトルに種類と概要を記載するフォーマットを導入
- コミットメッセージの種類（feat, fix, docs, styleなど）の説明を追加
- ドキュメントテンプレートにコミットメッセージのフォーマットとタイプの説明を追記

機能改善

- コマンドラインからソースコードのリポジトリパスを取得するように修正
- `StagedDiffGenerator`クラスのコンストラクタ引数`repo_path`を、定数`const.REPO_PATH`から現在のワーキングディレクトリを取得する`os.getcwd()`に変更
- これにより、コマンドラインから`SourceSage.py`を実行する際に、ソースコードのリポジトリパスを適切に取得できるようになり、より柔軟に利用可能に
- `IssuesToMarkdown`クラスに`loguru`を使用したログ出力を追加
- `load_data()`メソッド内で、データのロード状況をログ出力するように改善
- `create_markdown_files()`メソッド内で、マークダウンファイルの作成状況をログ出力するように改善
- これにより、処理の進行状況や重要な情報がログに記録され、デバッグやモニタリングがしやすくなった
- ドキュメントのフォーマットを改善
- コミットメッセージのフォーマットをマークダウン形式に変更し、種類の説明を追加
- これにより、ドキュメントの読みやすさが向上し、コミットメッセージの作成がより明確に

リファクタリング

- 定数の管理方法を改善
- 環境変数の利用をやめ、定数を一箇所で管理するように変更
- `config/constants.py`ファイルを新規作成し、定数を定義
- `SourceSage.py`の`main`関数内で定数を使用するように修正
- これにより、コードの可読性と保守性が向上し、定数の管理がシンプルになった
- Git関係のモジュールのリファクタリング
- `GitHubIssueRetrieve.py`と`StagedDiffGenerator.py`の重複部分を削除し、`GitHubUtils.py`モジュールにまとめた
- `ChangelogGenerator.py`と`DiffChangelogGenerator.py`の共通部分を`ChangelogUtils.py`モジュールに抽出
- これにより、モジュール間の依存関係が整理され、コードの可読性と保守性が向上
- ドキュメントテンプレートを整理
- ドキュメントのテンプレートファイルを`docs`ディレクトリ下に移動
- テンプレートファイルのパスを定数で管理するように変更

その他の変更
- `.gitignore`ファイルの更新
- パッケージのバージョン番号を3.1.0に更新

以上の変更により、SourceSageの機能性と保守性が向上し、より効率的で使いやすいツールになりました。今後もフィードバックを取り入れながら、継続的な改善を行っていきます。

tag3.0.0
SourceSageは、プロジェクトのソースコードとファイル構成を単一のマークダウンファイルに統合し、AIによる自動修正やドキュメント化を実現するPythonスクリプトです。開発のライフサイクル全体を通して、コードの品質向上と生産性の向上を支援します。

新機能

IssueWise - 開発前の課題解決

- GitHubのオープンIssueを自動取得し、AIによる課題の自動修正をサポート
- 課題を効率的に特定し、迅速に解決策を見つけられます

CommitCraft - 開発中のコミット管理

- 変更差分を追跡し、AIが適切なコミットメッセージを自動生成
- コミットの内容を正確に記述でき、変更履歴を明確に管理できます

DocuMind - リリース後のドキュメント化

- プロジェクトの概要とGitの変更履歴を組み合わせてドキュメント化
- プロジェクトの全体像を把握しやすく、メンテナンス性が向上します

機能改善

- ChangelogGeneratorクラスを導入し、コードの可読性と保守性を向上
- 言語ごとのシンタックスハイライト機能を追加し、複数の言語に対応
- 対象フォルダの指定やファイルの除外設定を複数行に対応させ、柔軟性を向上
- コード生成時のエラー処理を改善
- 設定ファイルの場所を外部化し、全体的な設定の管理が容易になりました

バグ修正

- 2 SourceSage.pyのパラメータを環境変数(.env)から設定できるように修正
- [fix] issue2 SourceSage.pyのパラメータを環境変数(.env)から設定できるようにする
- 7 6 MarkdownファイルからAIに入力して自動修正できる機能を追加
- [feat] コミットメッセージのフォーマットとタイプの説明を追加
- [feat] ステージの差分生成と課題の取得を実装 3
- 4 リファクタリングによるコード構造の改善
- [refactor] Git関連モジュールのリファクタリング

その他の変更

- .SourceSageignoreファイルを導入し、不要なファイルやフォルダを自動的に除外できるようになりました
- ソースコードの可読性と保守性を高めるためのリファクタリングが行われました
- READMEファイルと各種ドキュメントが改善され、プロジェクトの理解が容易になりました

tag2.0.0

はじめに
SourceSage 2.0.0のリリースを発表できることを嬉しく思います！このバージョンでは、ツールの使いやすさ、保守性、効率性を向上させるために、いくつかの重要な機能強化と新機能が導入されています。SourceSageは、プロジェクトのソースコードとファイル構造を単一のマークダウンファイルに統合するPythonスクリプトで、大規模な言語モデル（AI）がプロジェクト全体の構造と内容を容易に理解できるようにします。

新機能
- **ChangelogGeneratorクラス**: コードの可読性と保守性を向上させるために、ChangelogGeneratorクラスを導入しました。このクラスは、`get_repo()`、`get_commits()`、`format_commit()`の各機能を統合し、コードをよりモジュール化し、再利用しやすくしています。
- **シンタックスハイライト**: SourceSageは、複数のプログラミング言語のシンタックスハイライトをサポートするようになりました。この機能により、生成されたマークダウンファイルの可読性が向上し、ソースコードスニペットの理解が容易になります。
- **柔軟な除外設定**: ファイルとフォルダの除外設定を改善し、複数行をサポートするようになりました。これにより、ユーザーは生成されたマークダウンファイルから除外するファイルとフォルダを簡単に指定できます。
- **外部設定ファイル**: 設定を別のファイルに外部化し、ツールの動作を管理しカスタマイズしやすくなりました。
- **.SourceSageignoreファイル**: 自動的に除外するファイルとフォルダを列挙する`.SourceSageignore`ファイルを導入しました。この機能により、プロジェクトの整理が簡素化され、不要なファイルやフォルダが生成されたマークダウンファイルに含まれないようになります。
- **Git変更履歴**: SourceSageは、Git変更履歴を自動的に生成してドキュメント化するようになりました。この機能により、開発プロセスの透明性と可視性が向上し、変更の追跡とプロジェクトの進化の理解が容易になります。

改良点
- **エラー処理**: コード生成時のエラー処理を改善し、ツールをより堅牢でユーザーフレンドリーにしました。
- **コードの可読性**: コードベースをリファクタリングして、可読性と保守性を向上させました。不要なコメントを削除し、コード構造を最適化して理解しやすくしました。
- **READMEの改善**: プロジェクトのREADMEファイルを統合し、ツールの機能、使用方法、例をより明確かつ簡潔に説明するように改良しました。

変更履歴
変更とコミットの詳細については、[統合された変更履歴(docs/Changelog/CHANGELOG_integrated.md)](docs/Changelog/CHANGELOG_integrated.md)ファイルを参照してください。

アップグレード手順