search

Sunwood-ai-labs / IRIS

I.R.I.S（Intelligent Repository Issue Solver）
2 stars 1 forks source link

READMEを見やすくしたい #18

Open Sunwood-ai-labs opened 4 months ago

Sunwood-ai-labs commented 4 months ago

初心者でも分かるようなREADMEにしたい！

iris-s-coon commented 4 months ago

I.R.I.S Bot🤖が以下のラベルを提案し、適用しました：

iris-s-coon commented 4 months ago

READMEの改善点に関する詳細なコメント

README.md はプロジェクトの概要を理解し、利用を開始するための重要な情報源です。今回のイシューでは、「初心者でも分かるようなREADME」という要望が出ています。現状のREADME.mdを拝見しましたが、全体的にはよくまとまっている印象です。

しかしながら、初心者にとってより分かりやすく、使いやすくなるように、いくつか改善できるポイントがあります。

1. 🚀 スタートガイド の充実

現状、スタートガイドは項目として存在するものの、具体的な記述がありません。初心者にとって最も重要な情報の一つですので、以下の内容を盛り込むことを推奨します。

2. 🎥 デモ の追加

文章での説明に加えて、動画によるデモがあると、IRIS の動作をより直感的に理解することができます。短い動画で構いませんので、以下の内容を盛り込むことを検討してみて下さい。

3. 📁 リポジトリ構造 の図解化

現状、リポジトリ構造はツリー形式でテキスト表示されていますが、図解するとより視覚的に理解しやすくなります。

4. 🧪 開発用コマンド の整理

現状、開発用コマンドは aira と sourcesage を使用していますが、初心者には分かりにくいため、以下の改善を検討してください。

5. その他

これらの改善点を踏まえ、README.md をより分かりやすく、使いやすいものにすることで、IRIS をより多くのユーザーに利用してもらうことができると考えます。

iris-s-coon commented 4 months ago

変更提案

--- a/README.md
+++ b/README.md
@@ -18,68 +18,45 @@
 <a href="https://hamaruki.com/"><b>[🍀 Official Blog]</b></a>
 </p>

-</h2>
-
-</p>
-
->[!IMPORTANT]
->このリポジトリのリリースノートやREADME、コミットメッセージの9割近くは[claude.ai](https://claude.ai/)や[ChatGPT4](https://chatgpt.com/)を活用した[AIRA](https://github.com/Sunwood-ai-labs/AIRA), [SourceSage](https://github.com/Sunwood-ai-labs/SourceSage), [Gaiah](https://github.com/Sunwood-ai-labs/Gaiah), [HarmonAI_II](https://github.com/Sunwood-ai-labs/HarmonAI_II)で生成しています。
+</h2> </p>

 ## 🌟 はじめに

-I.R.I.S（Intelligent Repository Issue Solver）は、GitHubリポジトリのイシュー管理を劇的に向上させるインテリジェントアシスタントです。機械学習と自然言語処理を活用し、イシューの自動分類、優先順位付け、解決策の提案を行います。
-
-初めての方でも簡単に使い始められるよう、以下では詳しい説明と手順を記載しています。
+I.R.I.S（Intelligent Repository Issue Solver）は、GitHubリポジトリのイシュー管理を支援するツールです。
+GitHub Actionsを用いて、イシューに対して自動的にラベル付けを行います。
+
+## 🚀 特徴
+
+- 新しいイシューが作成されると、自動的に内容を分析してラベルを提案します。
+- 提案されたラベルは、イシューにコメントとして追加されます。
+- `.github/labels.csv` ファイルで、独自のラベルを定義することができます。

-## 🚀 機能
-
-- イシューの自動ラベリング：新しいイシューが作成されると、AIがその内容を分析し、適切なラベルを自動的に付与します。
-- 複数のAIモデルを活用したイシュー分析：OpenAI GPT-4やGoogle Generative AIなど、高度な自然言語処理モデルを用いて、イシューの内容を深く理解します。
-- GitHubアクションを通じた自動化プロセス：人間の介入なしに、24時間365日稼働します。
-- カスタマイズ可能なラベル管理：CSVファイルを通じて、プロジェクト固有のラベルを簡単に定義・管理できます。
-
-## 📁 リポジトリ構造
-
-```
-IRIS/
-├─ .github/
-│  ├─ disabled-workflows/
-│  ├─ scripts/
-│  │  └─ process_issue.py
-│  ├─ workflows/
-│  │  └─ issue-review.yml
-│  └─ labels.csv
-├─ docs/
-│  └─ .sourcesage_releasenotes.yml
-├─ issue_creator.log
-└─ README.md
-```
-
-## 🛠️ インストールと設定（初心者向けステップバイステップガイド）
+## 🛠️ インストールと設定

 1. **リポジトリのクローン**:
-   - GitHubアカウントをお持ちでない場合は、まず[GitHubに登録](https://github.com/join)してください。
    - [IRIS リポジトリ](https://github.com/Sunwood-ai-labs/IRIS)にアクセスし、緑色の「Code」ボタンをクリックします。
    - 「Download ZIP」を選択してファイルをダウンロードし、解凍します。

 2. **ワークフローファイルのコピー**:
-   - 解凍したフォルダ内の [`.github/workflows/issue-review.yml`](.github/workflows/issue-review.yml) ファイルを見つけます。
    - このファイルをあなたのGitHubリポジトリの `.github/workflows/` ディレクトリにコピーします。
-     （`.github/workflows/` ディレクトリがない場合は作成してください）
+   - `.github/workflows/` ディレクトリがない場合は作成してください

 3. **GitHubシークレットの設定**:
    - GitHubリポジトリのページで「Settings」タブをクリックします。
    - 左側のメニューから「Secrets and variables」→「Actions」を選択します。
    - 「New repository secret」ボタンをクリックし、以下のシークレットを追加します：
-     - `OPENAI_API_KEY`: OpenAIのAPIキー
-     - `GH_ACCESS_TOKEN`: GitHubのパーソナルアクセストークン
-     - `GEMINI_API_KEY`: Google AI StudioのAPIキー（オプション）
+     - `OPENAI_API_KEY`: OpenAI の API キー
+     - `GITHUB_TOKEN`: GitHub のパーソナルアクセストークン
+     - `GEMINI_API_KEY`: Google AI Studio の API キー (オプション)
    - これらのキーの取得方法が分からない場合は、各サービスのドキュメントを参照するか、開発者に相談してください。

 4. **ラベルの設定**:
    - `.github/labels.csv` ファイルを確認し、必要に応じてプロジェクト固有のラベルを追加または編集します。
+   - ラベルは `label,description` の形式で記述します。

 ## 🔧 使用方法

-IRISを設定したら、以下のように動作します：
+IRIS を設定したら、あとはリポジトリに新しいイシューを作成するだけです。

-1. あなたのリポジトリに新しいイシューが作成されると、IRISが自動的に起動します。
-2. AIがイシューの内容を分析します。
-3. 適切なラベルが提案され、自動的にイシューに適用されます。
-4. ラベリングの結果がイシューにコメントとして追加されます。
-
-特別な操作は必要ありません。新しいイシューを作成するだけで、IRISが自動的に処理を行います。
+イシューが作成されると、GitHub Actions が実行され、自動的にラベルが提案されます。

 ## 📝 更新情報

@@ -88,21 +65,11 @@
 - [v0.1.0](https://github.com/Sunwood-ai-labs/IRIS/releases/tag/v0.1.0): イシュー自動ラベリング機能の実装

 ## 🔄 ワークフロー
-
-IRISの動作フローを以下の図で説明します：
-
-```mermaid
-%%{init:{'theme':'base','themeVariables':{'primaryColor':'#024959','primaryTextColor':'#F2C335','primaryBorderColor':'#F2AE30','lineColor':'#A1A2A6','secondaryColor':'#593E25','tertiaryColor':'#F2C335','noteTextColor':'#024959','noteBkgColor':'#F2C335','textColor':'#024959','fontSize':'18px'}}}%%
-sequenceDiagram
-    participant 👤 as 🌟User
-    participant 🐙 as 🐙GitHub
-    participant 🤖 as 🤖I.R.I.S
-    participant 🧠 as 🧠AI Models
-    participant 📋 as 📋CSV Labels
-    
-    👤->>🐙: 🎫 新しいイシューを作成
-    🐙->>🤖: 🚀 GitHub Action トリガー
-    activate 🤖
-    🤖->>🐙: 📥 イシュー内容を取得
-    🐙-->>🤖: 📄 イシュー詳細
-    🤖->>🧠: 🔍 内容を分析リクエスト
-    activate 🧠
-    🧠-->>🤖: 🏷️ ラベル提案
-    deactivate 🧠
-    🤖->>📋: 🔍 提案されたラベルを照合
-    📋-->>🤖: ✅ 有効なラベル
-    🤖->>🐙: 🔖 検証済みラベルを適用
-    🤖->>🐙: 💬 コメントを追加
-    deactivate 🤖
-    🐙-->>👤: 📨 更新通知
-```
+1. イシューが作成されます。
+2. GitHub Actions が起動します。
+3. イシューの内容が分析されます。
+4. 適切なラベルが提案され、イシューにコメントとして追加されます。

 ## 🧪 開発用コマンド（上級者向け）

@@ -116,13 +83,13 @@
 sourcesage --yaml-file=docs\.sourcesage_releasenotes.yml

-## 🤝 コントリビューション +## 🤝 コントリビューション 💖

プロジェクトへの貢献を歓迎します！以下の方法で貢献できます：

  1. イシューを作成して改善点や問題点を報告

  2. 新機能の提案 -3. プルリクエストを送信してコードを改善 +3. プルリクエストを送信してコードを改善 👍

    First Contributions のガイドを参考にしてみてください。

@@ -139,4 +106,4 @@

  1. GitHubのIssuesページで新しいイシューを作成
  2. 公式ウェブサイトのお問い合わせフォームを利用

  3. Twitterでダイレクトメッセージを送信

    +