🔍

リポジトリ現状把握とGitHub Issue登録(開発日記 No.083)

に公開

関連リンク

はじめに

昨日は、rules-commonリポジトリの整理と新規リポジトリ作成の自動化スクリプト作成を行いました。今日は、新しく作成したContent-Converterリポジトリの現状を把握し、未実装の部分を洗い出してGitHubのIssueとして登録することが目標です。

背景と目的

リポジトリの初期化は完了したものの、全体像がまだ掴めていません。機能の仕様、テストコード、CI/CDパイプラインが揃っていれば、どこが不足しているか明確になるはずです。そこで、現状を正確に把握し、未実装または機能していない部分をIssueとして登録することで、今後の開発を効率的に進めることを目指します。

検討内容

まずは、リポジトリの構造を把握するために、ディレクトリツリーを確認しました。次に、setup.pyREADME.mdなどの主要なファイルを確認し、プロジェクトの詳細情報を把握しました。さらに、cli.pyconverter.pyfactory.pyなどのソースコードを詳細に確認し、実装状況を分析しました。テストコードについても、test_parser.pytest_zenn_provider.pyなどを確認しました。

テストコードの実行状況も確認したかったのですが、どうやらターミナルが応答しないという問題が発生してしまいました。原因は不明ですが、テスト実行は一旦保留とし、これまでの分析結果をもとに作業を進めることにしました。

実装内容

現状分析の結果、以下の課題があることがわかりました。

  1. LLMプロバイダーの実装(高優先度)
  2. CI/CDパイプラインの構築(中優先度)
  3. コマンドライン実行の動作検証(高優先度)
  4. ドキュメント整備(中優先度)
  5. テストカバレッジの向上(中優先度)
  6. 他プラットフォームへの対応拡張(低優先度)

これらの課題をissues.mdファイルにまとめ、その後、GitHubのIssueとして登録しました。

mcp1_create_issue を6回実行。結果要約: 以下6つのIssueを作成
1. LLMプロバイダーの実装
2. CI/CDパイプラインの構築
3. コマンドライン実行の動作検証
4. ドキュメント整備
5. テストカバレッジの向上
6. 他プラットフォームへの対応拡張

技術的なポイント

今回の作業では、リポジトリ全体を俯瞰的に把握することが重要でした。各ファイルの役割や依存関係を理解することで、未実装の部分や改善点を見つけやすくなります。また、優先順位をつけることで、効率的に開発を進めることができます。

所感

リポジトリの初期段階で現状を把握し、課題を明確にすることは、今後の開発において非常に重要だと感じました。特に、今回はターミナルの問題でテストコードの実行ができなかったため、ソースコードを丁寧に読み解く必要がありました。少し大変でしたが、各コンポーネントの理解が深まり、良い経験になりました。

Issue登録を通じて、今後の開発の方向性が見えてきたので、次回の開発が楽しみです。

今後の課題

今回はターミナルの問題でテストコードの実行ができなかったため、まずはこの問題を解決する必要があります。また、登録したIssueに基づいて、LLMプロバイダーの実装やCLIの動作検証など、優先度の高いタスクから順次取り組んでいく予定です。

まとめ

今日は、Content-Converterリポジトリの現状分析とIssue登録を行いました。リポジトリの構造、実装状況、課題を明確にすることができ、今後の開発の方向性が見えてきました。特に、LLM機能とCLIの動作検証から実装を進めることで、効率的な開発が可能になると考えています。

GitHubで編集を提案

Discussion