Sourcesage

ぜひ新しいバージョンをお試しいただき、フィードバックをお寄せください。今後もSourceSageの機能拡張と改善に取り組んでいきます。

機能強化

- setup.pyのバージョンを4.1.1から4.1.2に更新し、最新の変更が反映されるようになりました。
- setup.pyに説明コメントを追加し、各設定項目の目的を明確にしました。これにより、他の開発者がコードを理解しやすくなります。
- setup.pyの依存関係を`requirements.txt`から動的に読み込むように変更し、依存関係管理の透明性と更新の容易さを向上させました。
- `requirements.txt`に新しいPythonライブラリ（loguru、GitPython、requests、art）を追加し、開発の効率と体験を向上させました。
- GitHub Actionsを通じてPyPIへの自動パブリッシュ設定を追加し、ソフトウェアのリリースプロセスを自動化しました。

リファクタリング

- setup.pyのインデントを調整し、コードの可読性を向上させました。

ドキュメントの改善

- ドキュメント内のリンクを修正し、正しい参照先にアクセスできるようになりました。
- README.mdのバージョン情報を更新し、最新のリリース情報を反映しました。


undefined4.1.1
概要

今後もSourceSageは、ユーザーと開発者双方のフィードバックを取り入れながら、継続的な改善と機能追加を行っていきます。ご期待ください！

undefined4.0.3

新機能

README.mdの設定手順をセットアップ手順に更新

README.mdにおけるプロジェクト設定手順のセクションを、より簡潔で直接的なセットアップ手順に更新しました。具体的には、`pip install sourcesage`によるインストール方法に変更し、ユーザーがプロジェクトをより簡単にセットアップできるようになりました。

README.mdの実行手順の簡素化

README.mdに記載された実行手順を簡素化しました。`sourcesage`コマンドを使用するように変更し、ユーザーがコマンドをより容易に記憶し実行できるようにしました。この変更により、ユーザーインターフェースの向上が期待されます。

コマンドライン引数にリポジトリのオーナーと名前を指定可能に

`cli.py`に`--owner`と`--repository`の引数を追加し、ユーザーはリポジトリのオーナーとリポジトリ名をコマンドラインから簡単に指定できるようになりました。これにより、異なるリポジトリに対してのサポートが強化されます。

改善


CLI引数の取り扱いを改善

`sourcesage/cli.py`ファイルにて、CLI引数のデフォルト値の設定方法を変更し、`argparse`のデフォルト機能を利用するようにしました。この変更により、コードがより簡潔になり、可読性が向上しました。

`Constants`クラスのコンストラクタに`owner`と`repository`を追加

`constants.py`の`Constants`クラスのコンストラクタが、リポジトリのオーナーとリポジトリ名を受け取るように変更されました。また、`SourceSage`クラスの初期化メソッドにもこれらの引数を追加しました。

ドキュメント

テスト実行方法のドキュメントを更新

`tests/README.md`の内容を更新して、テスト実行に関する説明をより明確かつ具体的にしました。これにより、テストプロセスの実行方法が明確になります。

テスト手順のドキュメントを追加

`tests/README.md`にテスト手順のドキュメントを新規作成しました。このドキュメントでは、特定のコマンドを使用してテストを実行する方法について説明しています。


バグ修正

- `DOCS_DIR`のパスが誤って`docs`フォルダを指していたのを、正しく`config`フォルダを指すように修正しました。

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ファイルと各種ドキュメントが改善され、プロジェクトの理解が容易になりました