ソフトウェア開発を効率化する「SourceSage」の使い方

ソフトウェア開発において、コードの品質向上やドキュメント管理は重要ですが、手間のかかる作業です。「SourceSage」は、AIの力を活用してこれらの課題を自動化し、開発のライフサイクル全体を通して生産性向上を支援するPythonツールです。

この記事では、まずSourceSageのインストールと基本的な使い方を解説し、続いて3つの主要機能である「IssueWise」「CommitCraft」「DocuMind」について、具体的な使用例を交えながら丁寧に説明します。

SourceSageのクイックスタート

SourceSageを使用するには、以下のようにpipでインストールします。

pip install sourcesage

cd ~/my_project

sourcesage

sourcesage --owner Sunwood-ai-labs --repository SourceSage

# .SourceSageignoreの例
node_modules/
*.log
*.tmp

SourceSageを実行すると、SourceSageAssetsディレクトリに各種ファイルが生成されます。これらのファイルをAIに入力することで、課題修正やコミットメッセージ生成、ドキュメント化などを自動で行えます。

IssueWiseは、GitHubのオープンIssue（未解決の課題）を自動取得し、SourceSageが生成したプロジェクト概要と組み合わせることで、AIによる課題の自動修正をサポートします。

SourceSageを実行すると、SourceSageAssets/ISSUE_WISE/ISSUES_RESOLVEディレクトリにマークダウンファイルが生成されます。
このマークダウンファイル（例: docs/SAMPLE/SAMPLE_ISSUE_11.md）をそのままChatGPTなどのAIに入力します。

例えば、あるプロジェクトで「ログイン機能が動作しない」というIssueが上がっているとします。IssueWiseを使うと、関連するソースコードとIssueの説明をまとめたマークダウンファイルが自動生成されます。

これをAIに渡すことで、「LoginControllerクラスのauthenticateメソッドの条件分岐に誤りがある」といった具体的な指摘と修正コードの提案が得られるかもしれません。開発者はAIからのフィードバックをもとに問題箇所を特定し、素早く修正を行えます。

CommitCraftは、開発中のコード変更を追跡し、AIを活用して適切なコミットメッセージを自動生成するツールです。

コードの変更をステージングした状態でSourceSageを実行すると、SourceSageAssets/COMMIT_CRAFT/STAGED_DIFF.mdファイルが生成されます。
このマークダウンファイル（例: docs/SAMPLE/SAMPLE_STAGE_INFO_AND_PROMT.md）をそのままAIに入力します。

例えば、あるコミットで「ユーザープロフィールの編集機能を追加」という変更が行われたとします。CommitCraftを使うと、変更差分とその説明を含むマークダウンファイルが自動生成されます。

これをAIに渡すと、「feat: ユーザープロフィール編集機能の追加 (#123)」といった、変更内容を端的に表現したコミットメッセージが提案されます。開発者は内容を確認し、必要であれば修正を加えてからgit commitを実行できます。

ステージされた変更とオープンIssueの情報を組み合わせたマークダウンファイル（例: docs/SAMPLE/SAMPLE_STAGE_INFO_AND_ISSUES_AND_PROMT.md）を使うと、Issueの文脈を踏まえたより適切なコミットメッセージが得られます。

DocuMindは、リリース後のプロジェクトを統合的にドキュメント化するためのツールです。SourceSageが生成するプロジェクト概要と、自動生成されたコミット履歴を組み合わせることで、AIがプロジェクトの全体像を把握し、ドキュメントを自動生成します。

SourceSageを実行すると、SourceSageAssets/DocuMind.mdファイルとSourceSageAssets/Changelogディレクトリ内のマークダウンファイルが生成されます。
これらのファイル（例: docs/SAMPLE/SAMPLE_DocuMind.mdとdocs/SAMPLE/SAMPLE_CHANGELOG_release_4.1.0.md）をそのままAIに入力します。