Maki commited on
Commit
2b5ca13
0 Parent(s):

Initial commit

Browse files
Files changed (8) hide show
  1. .aira/config.IRIS.yml +71 -0
  2. .aira/config.dev.commit.yml +26 -0
  3. .env.example +7 -0
  4. .gitignore +162 -0
  5. LICENSE +21 -0
  6. README.md +245 -0
  7. docs/README.en.md +245 -0
  8. requirements.txt +2 -0
.aira/config.IRIS.yml ADDED
@@ -0,0 +1,71 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ aira:
2
+ gaiah: # 共通設定
3
+ run: true
4
+ repo:
5
+ repo_name: "IRIS"
6
+ description: "I.R.I.S(Intelligent Repository Issue Solver)"
7
+ private: false
8
+ local:
9
+ repo_dir: "C:/Prj/IRIS"
10
+ no_initial_commit: false
11
+ commit:
12
+ commit_msg_path: ".Gaiah.md"
13
+ branch_name: null
14
+
15
+ dev: # 開発時の設定 (必要に応じて上書き)
16
+ repo:
17
+ create_repo: false
18
+ local:
19
+ init_repo: false
20
+ commit:
21
+ process_commits: true
22
+
23
+ init: # 初期化時の設定 (必要に応じて上書き)
24
+ repo:
25
+ create_repo: true
26
+ local:
27
+ init_repo: true
28
+ commit:
29
+ process_commits: false
30
+
31
+ llm:
32
+ model: "gemini/gemini-1.5-pro-latest" # 利用するLLMモデル
33
+
34
+ repository_summary_output_dir: .aira # リポジトリ概要の出力ディレクトリ
35
+ readme_prompt_template_path: .aira/readme_prompt_template.txt # README生成のプロンプトテンプレートのパス
36
+
37
+ harmon_ai:
38
+ run: true
39
+ environment:
40
+ repo_name: "IRIS"
41
+ owner_name: "Sunwood-ai-labs"
42
+ package_name: "IRIS"
43
+ icon_url: "https://huggingface.co/datasets/MakiAi/IconAssets/resolve/main/IRIS.png"
44
+ title: "IRIS"
45
+ subtitle: "~ Intelligent Repository Issue Solver ~"
46
+ website_url: "https://hamaruki.com/"
47
+ github_url: "https://github.com/Sunwood-ai-labs"
48
+ twitter_url: "https://x.com/hAru_mAki_ch"
49
+ blog_url: "https://hamaruki.com/"
50
+
51
+ product:
52
+ important_message_file: "important_template.md"
53
+ sections_content_file: "sections_template.md"
54
+ output_file: "README_template.md"
55
+ cicd_file_path: "publish-to-pypi.yml"
56
+ cicd_main_path: "publish-to-pypi.yml"
57
+ github_cicd_dir: ".github/workflows"
58
+
59
+ llm_product:
60
+ sections_content_file: "sections_template_llm.md"
61
+
62
+ development:
63
+ output_dir: "C:/Prj/IRIS/.harmon_ai"
64
+
65
+ main:
66
+ main_dir: "C:/Prj/IRIS/"
67
+ replace_readme: true
68
+
69
+ instructions_prompt: .aira/instructions.IRIS.md
70
+
71
+ # aira --mode=make --config=.aira\config.IRIS.yml
.aira/config.dev.commit.yml ADDED
@@ -0,0 +1,26 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ aira:
2
+ gaiah: # 共通設定
3
+ run: true
4
+ repo:
5
+ repo_name: "AIRA-Sample04"
6
+ description: ""
7
+ private: True
8
+ local:
9
+ repo_dir: "./"
10
+ no_initial_commit: false
11
+ commit:
12
+ commit_msg_path: ".SourceSageAssets/COMMIT_CRAFT/llm_output.md"
13
+ branch_name: null
14
+
15
+ dev: # 開発時の設定 (必要に応じて上書き)
16
+ repo:
17
+ create_repo: false
18
+ local:
19
+ init_repo: false
20
+ commit:
21
+ process_commits: true
22
+
23
+ # aira --mode sourcesage commit --config=.aira\config.dev.commit.yml --ss-model-name="gemini/gemini-1.5-pro-latest" --llm-output="llm_output.md" --ignore-file=".iris.SourceSageignore"
24
+ # aira --mode sourcesage commit --config=.aira\config.dev.commit.yml --ss-model-name="gemini/gemini-1.5-flash-002" --llm-output="llm_output.md"
25
+ # aira --mode sourcesage commit --config=.aira\config.dev.commit.yml --ss-model-name="gpt-4o-mini" --llm-output="llm_output.md"
26
+ # sourcesage --ignore-file=".iris.SourceSageignore"
.env.example ADDED
@@ -0,0 +1,7 @@
 
 
 
 
 
 
 
 
1
+ # GitHubアクセストークン(コラボレーター招待用)
2
+ GITHUB_TOKEN=your_github_personal_access_token_here
3
+
4
+ # 以下は他の機能で使用する可能性のあるトークンの例です。記載しておくと後々便利です。
5
+ # GITHUB_ACCESS_TOKEN=ghp_xxxxx
6
+ # YOUR_PERSONAL_ACCESS_TOKEN_IRIS=ghp_yyyyy
7
+ # GEMINI_API_KEY=AIzzzzz
.gitignore ADDED
@@ -0,0 +1,162 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Byte-compiled / optimized / DLL files
2
+ __pycache__/
3
+ *.py[cod]
4
+ *$py.class
5
+
6
+ # C extensions
7
+ *.so
8
+
9
+ # Distribution / packaging
10
+ .Python
11
+ build/
12
+ develop-eggs/
13
+ dist/
14
+ downloads/
15
+ eggs/
16
+ .eggs/
17
+ lib/
18
+ lib64/
19
+ parts/
20
+ sdist/
21
+ var/
22
+ wheels/
23
+ share/python-wheels/
24
+ *.egg-info/
25
+ .installed.cfg
26
+ *.egg
27
+ MANIFEST
28
+
29
+ # PyInstaller
30
+ # Usually these files are written by a python script from a template
31
+ # before PyInstaller builds the exe, so as to inject date/other infos into it.
32
+ *.manifest
33
+ *.spec
34
+
35
+ # Installer logs
36
+ pip-log.txt
37
+ pip-delete-this-directory.txt
38
+
39
+ # Unit test / coverage reports
40
+ htmlcov/
41
+ .tox/
42
+ .nox/
43
+ .coverage
44
+ .coverage.*
45
+ .cache
46
+ nosetests.xml
47
+ coverage.xml
48
+ *.cover
49
+ *.py,cover
50
+ .hypothesis/
51
+ .pytest_cache/
52
+ cover/
53
+
54
+ # Translations
55
+ *.mo
56
+ *.pot
57
+
58
+ # Django stuff:
59
+ *.log
60
+ local_settings.py
61
+ db.sqlite3
62
+ db.sqlite3-journal
63
+
64
+ # Flask stuff:
65
+ instance/
66
+ .webassets-cache
67
+
68
+ # Scrapy stuff:
69
+ .scrapy
70
+
71
+ # Sphinx documentation
72
+ docs/_build/
73
+
74
+ # PyBuilder
75
+ .pybuilder/
76
+ target/
77
+
78
+ # Jupyter Notebook
79
+ .ipynb_checkpoints
80
+
81
+ # IPython
82
+ profile_default/
83
+ ipython_config.py
84
+
85
+ # pyenv
86
+ # For a library or package, you might want to ignore these files since the code is
87
+ # intended to run in multiple environments; otherwise, check them in:
88
+ # .python-version
89
+
90
+ # pipenv
91
+ # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
92
+ # However, in case of collaboration, if having platform-specific dependencies or dependencies
93
+ # having no cross-platform support, pipenv may install dependencies that don't work, or not
94
+ # install all needed dependencies.
95
+ #Pipfile.lock
96
+
97
+ # poetry
98
+ # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
99
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
100
+ # commonly ignored for libraries.
101
+ # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
102
+ #poetry.lock
103
+
104
+ # pdm
105
+ # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
106
+ #pdm.lock
107
+ # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
108
+ # in version control.
109
+ # https://pdm.fming.dev/latest/usage/project/#working-with-version-control
110
+ .pdm.toml
111
+ .pdm-python
112
+ .pdm-build/
113
+
114
+ # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
115
+ __pypackages__/
116
+
117
+ # Celery stuff
118
+ celerybeat-schedule
119
+ celerybeat.pid
120
+
121
+ # SageMath parsed files
122
+ *.sage.py
123
+
124
+ # Environments
125
+ .env
126
+ .venv
127
+ env/
128
+ venv/
129
+ ENV/
130
+ env.bak/
131
+ venv.bak/
132
+
133
+ # Spyder project settings
134
+ .spyderproject
135
+ .spyproject
136
+
137
+ # Rope project settings
138
+ .ropeproject
139
+
140
+ # mkdocs documentation
141
+ /site
142
+
143
+ # mypy
144
+ .mypy_cache/
145
+ .dmypy.json
146
+ dmypy.json
147
+
148
+ # Pyre type checker
149
+ .pyre/
150
+
151
+ # pytype static type analyzer
152
+ .pytype/
153
+
154
+ # Cython debug symbols
155
+ cython_debug/
156
+
157
+ # PyCharm
158
+ # JetBrains specific template is maintained in a separate JetBrains.gitignore that can
159
+ # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
160
+ # and can be added to the global gitignore or merged into this file. For a more nuclear
161
+ # option (not recommended) you can uncomment the following to ignore the entire idea folder.
162
+ #.idea/
LICENSE ADDED
@@ -0,0 +1,21 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ MIT License
2
+
3
+ Copyright (c) 2024 Maki
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
README.md ADDED
@@ -0,0 +1,245 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ <p align="center">
2
+ <img src="https://raw.githubusercontent.com/Sunwood-ai-labs/HarmonAI_III/refs/heads/main/docs/HarmonAI-III.png" width="100%">
3
+ <h1 align="center">🌟 HarmonAI III 🌟</h1>
4
+ </p>
5
+
6
+ <p align="center">
7
+ <a href="https://github.com/Sunwood-ai-labs/HarmonAI_III">
8
+ <img alt="GitHub Repo" src="https://img.shields.io/badge/github-HarmonAI__III-blue?logo=github">
9
+ </a>
10
+ <a href="https://github.com/Sunwood-ai-labs/HarmonAI_III/blob/main/LICENSE">
11
+ <img alt="License" src="https://img.shields.io/github/license/Sunwood-ai-labs/HarmonAI_III?color=green">
12
+ </a>
13
+ <a href="https://github.com/Sunwood-ai-labs/HarmonAI_III/stargazers">
14
+ <img alt="GitHub stars" src="https://img.shields.io/github/stars/Sunwood-ai-labs/HarmonAI_III?style=social">
15
+ </a>
16
+ <a href="https://github.com/Sunwood-ai-labs/HarmonAI_III/releases">
17
+ <img alt="GitHub release" src="https://img.shields.io/github/v/release/Sunwood-ai-labs/HarmonAI_III?include_prereleases&style=flat-square">
18
+ </a>
19
+ <a href="https://github.com/Sunwood-ai-labs/HarmonAI_III/graphs/commit-activity">
20
+ <img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/m/Sunwood-ai-labs/HarmonAI_III">
21
+ </a>
22
+ <a href="https://github.com/Sunwood-ai-labs/HarmonAI_III/pulls">
23
+ <img alt="PRs Welcome" src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square">
24
+ </a>
25
+ <img alt="GitHub repo size" src="https://img.shields.io/github/repo-size/Sunwood-ai-labs/HarmonAI_III">
26
+ <img alt="Development Status" src="https://img.shields.io/badge/status-active-success.svg">
27
+ <a href="https://github.com/Sunwood-ai-labs/HarmonAI_III/issues">
28
+ <img alt="GitHub issues" src="https://img.shields.io/github/issues/Sunwood-ai-labs/HarmonAI_III">
29
+ </a>
30
+ <a href="https://github.com/Sunwood-ai-labs/HarmonAI_III/network/members">
31
+ <img alt="GitHub forks" src="https://img.shields.io/github/forks/Sunwood-ai-labs/HarmonAI_III?style=social">
32
+ </a>
33
+ <a href="https://github.com/Sunwood-ai-labs/HarmonAI_III/watchers">
34
+ <img alt="GitHub watchers" src="https://img.shields.io/github/watchers/Sunwood-ai-labs/HarmonAI_III?style=social">
35
+ </a>
36
+ <img alt="GitHub last commit" src="https://img.shields.io/github/last-commit/Sunwood-ai-labs/HarmonAI_III">
37
+ <img alt="GitHub top language" src="https://img.shields.io/github/languages/top/Sunwood-ai-labs/HarmonAI_III">
38
+ <a href="https://github.com/Sunwood-ai-labs/HarmonAI_III/graphs/contributors">
39
+ <img alt="GitHub contributors" src="https://img.shields.io/github/contributors/Sunwood-ai-labs/HarmonAI_III">
40
+ </a>
41
+ <a href="https://github.com/Sunwood-ai-labs/HarmonAI_III/issues?q=is%3Aissue+is%3Aclosed">
42
+ <img alt="GitHub closed issues" src="https://img.shields.io/github/issues-closed/Sunwood-ai-labs/HarmonAI_III">
43
+ </a>
44
+ <a href="https://github.com/Sunwood-ai-labs/HarmonAI_III/pulls?q=is%3Apr+is%3Aclosed">
45
+ <img alt="GitHub closed PRs" src="https://img.shields.io/github/issues-pr-closed/Sunwood-ai-labs/HarmonAI_III">
46
+ </a>
47
+ <img alt="GitHub language count" src="https://img.shields.io/github/languages/count/Sunwood-ai-labs/HarmonAI_III">
48
+ <img alt="GitHub search hit counter" src="https://img.shields.io/github/search/Sunwood-ai-labs/HarmonAI_III/goto">
49
+ <img alt="GitHub code size" src="https://img.shields.io/github/languages/code-size/Sunwood-ai-labs/HarmonAI_III">
50
+ <a href="https://github.com/Sunwood-ai-labs/HarmonAI_III/blob/main/CONTRIBUTING.md">
51
+ <img src="https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg" alt="Contributor Covenant">
52
+ </a>
53
+ <a href="https://twitter.com/intent/tweet?text=Check%20out%20this%20awesome%20project%3A&url=https%3A%2F%2Fgithub.com%2FSunwood-ai-labs%2FHarmonAI_III">
54
+ <img alt="Twitter" src="https://img.shields.io/twitter/url?style=social&url=https%3A%2F%2Fgithub.com%2FSunwood-ai-labs%2FHarmonAI_III">
55
+ </a>
56
+ <img alt="GitHub Created At" src="https://img.shields.io/github/created-at/Sunwood-ai-labs/HarmonAI_III">
57
+ <a href="https://github.com/Sunwood-ai-labs/HarmonAI_III/deployments">
58
+ <img alt="GitHub deployments" src="https://img.shields.io/github/deployments/Sunwood-ai-labs/HarmonAI_III/Production">
59
+ </a>
60
+ <a href="https://github.com/Sunwood-ai-labs/HarmonAI_III/discussions">
61
+ <img alt="GitHub Discussions" src="https://img.shields.io/github/discussions/Sunwood-ai-labs/HarmonAI_III">
62
+ </a>
63
+ <img alt="GitHub followers" src="https://img.shields.io/github/followers/Sunwood-ai-labs?style=social">
64
+ <img alt="GitHub Release Date" src="https://img.shields.io/github/release-date/Sunwood-ai-labs/HarmonAI_III">
65
+ <img alt="GitHub commit activity (branch)" src="https://img.shields.io/github/commit-activity/y/Sunwood-ai-labs/HarmonAI_III/main">
66
+ <img alt="GitHub commits since latest release (by date)" src="https://img.shields.io/github/commits-since/Sunwood-ai-labs/HarmonAI_III/latest">
67
+
68
+
69
+ </a>
70
+ </p>
71
+
72
+ <p align="center">
73
+ <a href="https://github.com/Sunwood-ai-labs/HarmonAI_III/actions/workflows/generate-release-notes.yml">
74
+ <img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/Sunwood-ai-labs/HarmonAI_III/generate-release-notes.yml?label=generate-auto-release-notes">
75
+ <a href="https://github.com/Sunwood-ai-labs/HarmonAI_III/actions/workflows/translate-readme.yml">
76
+ <img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/Sunwood-ai-labs/HarmonAI_III/generate-release-notes.yml?label=auto-translate-readme">
77
+ <a href="https://github.com/Sunwood-ai-labs/HarmonAI_III/actions/workflows/issue-review.yml">
78
+ <img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/Sunwood-ai-labs/HarmonAI_III/generate-release-notes.yml?label=auto-issue-review">
79
+ </p>
80
+ <h2 align="center">
81
+ ~ AI-Powered Automated Repository Management Template ~
82
+
83
+ <a href="https://github.com/Sunwood-ai-labs/HarmonAI_III/blob/main/README.md"><img src="https://img.shields.io/badge/ドキュメント-日本語-white.svg" alt="JA doc"/></a>
84
+ <a href="https://github.com/Sunwood-ai-labs/HarmonAI_III/blob/main/docs/README.en.md"><img src="https://img.shields.io/badge/english-document-white.svg" alt="EN doc"></a>
85
+ </h2>
86
+
87
+ > [!IMPORTANT]
88
+ > HarmonAI IIIは、[cline (旧:Claude Dev)](https://github.com/clinebot/cline), [SourceSage](https://github.com/Sunwood-ai-labs/SourceSage), [claude.ai](https://claude.ai/)を活用して開発されたテンプレートリポジトリです。リリースノート、README、コミットメッセージの大部分は、最新のAI技術を用いて生成されています。
89
+
90
+ ## 🚀 プロジェクト概要
91
+
92
+ HarmonAI IIIは、AIRAとIRISを統合した革新的な**AIリポジトリスターターキット**です。このリポジトリは、LLMを活用したAI開発プロジェクトの構造とワークフローを提供し、開発者の作業効率を劇的に向上させることを目的としています。バージョン: `v1.2.0`
93
+
94
+
95
+ ## 🆕 最新情報
96
+
97
+ - 🎉 v1.2.0リリース: READMEへのGitHub Shieldsの追加、コラボレーター招待機能の追加、ドキュメントの更新を行いました。
98
+
99
+
100
+ ## ✨ 主な機能
101
+
102
+ 1. **統合AIツールセット**: AIRAとIRISの機能を1つのパッケージで提供
103
+ 2. **即時利用可能**: テンプレートとして使用することで、高品質な初期構造を持つリポジトリを簡単に作成
104
+ 3. **自動化された開発ワークフロー**: コミットメッセージ生成、リリースノート作成、イシュー管理の自動化
105
+ 4. **多言語サポート**: READMEの自動翻訳機能により、国際的なプロジェクト展開をサポート
106
+ 5. **柔軟なカスタマイズ**: プロジェクトのニーズに合わせて容易に調整可能
107
+ 6. **コラボレーター自動招待**: GitHub APIを利用したコラボレーター招待スクリプト
108
+
109
+
110
+ ## 🔧 使用方法
111
+
112
+ ### AIRAの使用例:
113
+ ```bash
114
+ aira --mode sourcesage commit --config=.aira\config.dev.commit.yml --ss-model-name="gpt-4o-mini" --llm-output="llm_output.md"
115
+ ```
116
+
117
+ ### IRISの使用例:
118
+
119
+ 詳細な使用方法については、各コンポーネントのドキュメンテーションを参照してください。
120
+
121
+
122
+ ## 📦 インストール手順
123
+
124
+ 1. このリポジトリをテンプレートとして使用し、新しいリポジトリを作成します。
125
+ 2. リポジトリをローカルにクローンします。
126
+ 3. 必要な依存関係をインストールします:
127
+ ```bash
128
+ pip install -r requirements.txt
129
+ ```
130
+ 4. AIRAとIRISの設定ファイルをカスタマイズします。
131
+ 5. GitHub Actionsの設定を確認し、必要に応じて環境変数を設定します。
132
+ 6. `.github/release_notes/.sourcesage_releasenotes_iris.yml`ファイルを開き、`repo-name:`の値を新しいリポジトリ名に修正します。
133
+
134
+
135
+ ## 🌿 環境構築
136
+
137
+ HarmonAI IIIの環境を構築するには、以下の手順に従ってください:
138
+
139
+ 1. 仮想環境を作成します:
140
+ ```bash
141
+ python3 -m venv .venv
142
+ ```
143
+ これにより、`.venv`ディレクトリに仮想環境が作成されます。
144
+
145
+ 2. 仮想環境をアクティベートします:
146
+ ```bash
147
+ source .venv/bin/activate # Linux/macOS
148
+ .venv\Scripts\activate # Windows
149
+ ```
150
+
151
+ 3. 依存関係をインストールします:
152
+ ```bash
153
+ pip install -r requirements.txt
154
+ ```
155
+
156
+ これらの手順により、HarmonAI IIIの開発環境が整います。
157
+
158
+
159
+ ## 📚 主要コンポーネント
160
+
161
+ ### 🤖 [AIRA (AI-Integrated Repository for Accelerated Development)](https://github.com/Sunwood-ai-labs/AIRA)
162
+ - リポジトリ作成の自動化
163
+ - コミットメッセージの自動生成
164
+
165
+ ### 🌈 [IRIS (Intelligent Repository Issue Solver)](https://github.com/Sunwood-ai-labs/IRIS)
166
+ - イシューの自動分類
167
+ - 解決策の自動提案
168
+ - リリースノートの自動生成
169
+ - READMEの自動翻訳
170
+
171
+ ## 🤝 コラボレーターの自動招待
172
+
173
+ HarmonAI IIIには、GitHubリポジトリにコラボレーターを��動で招待するスクリプトが含まれています。以下の手順で使用できます:
174
+
175
+ 1. `.env` ファイルを作成し、必要なトークンを設定します:
176
+ ```
177
+ # GitHubアクセストークン(コラボレーター招待用)
178
+ GITHUB_TOKEN=your_github_personal_access_token_here
179
+
180
+ # 以下は他の機能で使用する可能性のあるトークンの例です。記載しておくと後々便利です。
181
+ # GITHUB_ACCESS_TOKEN=ghp_xxxxx
182
+ # YOUR_PERSONAL_ACCESS_TOKEN_IRIS=ghp_yyyyy
183
+ # GEMINI_API_KEY=AIzzzzz
184
+ ```
185
+
186
+ 注意: `.env` ファイルは `.gitignore` に含めて、リポジトリにコミットしないようにしてください。
187
+
188
+ 2. 以下のコマンドを実行してコラボレーターを招待します:
189
+ ```bash
190
+ python .github/github_add_collaborator.py Sunwood-ai-labs/HarmonAI_III username_to_invite
191
+ ```
192
+
193
+ `username_to_invite` は招待したいGitHubユーザー名に置き換えてください。
194
+
195
+ 3. スクリプトが正常に実行されると、指定したユーザーにコラボレーター招待が送信されます。
196
+
197
+ 注意事項:
198
+ - このスクリプトを使用するには、GitHubトークンに適切な権限(`repo` スコープ)が必要です。
199
+ - 組織のリポジトリに対して使用する場合は、組織の設定で適切な権限が付与されていることを確認してください。
200
+ - セキュリティのため、トークンは定期的に更新し、必要最小限の権限のみを付与するようにしてください。
201
+ - `.env` ファイルやトークンを含む情報は、決して公開リポジトリにコミットしないでください。
202
+
203
+ この機能により、プロジェクトへの新しいコントリビューターの追加プロセスが簡素化されます。セキュリティを維持しながら、効率的にチームを拡大することができます。
204
+
205
+ ## 🐈 処理フロー
206
+
207
+
208
+ ```mermaid
209
+ %%{init:{'theme':'base','themeVariables':{'primaryColor':'#024959','primaryTextColor':'#F2C335','primaryBorderColor':'#F2AE30','lineColor':'#A1A2A6','secondaryColor':'#593E25','tertiaryColor':'#F2C335','noteTextColor':'#024959','noteBkgColor':'#F2C335','textColor':'#024959','fontSize':'18px'}}}%%
210
+
211
+ graph LR
212
+ A[開始] --> B[リポジトリの構想とネーミング]
213
+ B -->|人間が実施| C[HarmonAI IIIによる<br>リポジトリ初期化]
214
+ C -->|自動化| D[開発作業]
215
+ D -->|人間が実施| E[AIRAによる<br>コミット自動化]
216
+ E --> H[IRISによる<br>リリースノート作成]
217
+ H --> I[IRISによる<br>ドキュメント翻訳]
218
+ I --> J[リリース]
219
+ J --> K[終了]
220
+
221
+ class B,D,G human;
222
+ class E aira;
223
+ class F,H,I iris;
224
+ class C auto;
225
+ class A,J,K process;
226
+
227
+ ```
228
+
229
+
230
+
231
+ ## 🤝 コントリビューション
232
+
233
+ HarmonAI IIIは、オープンソースプロジェクトとしてコミュニティからの貢献を歓迎しています。バグ報告、機能リクエスト、プルリクエストを通じて、このテンプレートリポジトリの改善にご協力ください。
234
+
235
+ ## 📄 ライセンス
236
+
237
+ HarmonAI IIIは、[MITライセンス](LICENSE)の下で公開されています。
238
+
239
+ ## 🙏 謝辞
240
+
241
+ HarmonAI IIIの開発にあたり、多くのオープンソースプロジェクトからインスピレーションを得ています。特に、AIRAとIRISの開発者の皆様に深く感謝申し上げます。iris-s-coon、Maki様にも感謝いたします。
242
+
243
+ ---
244
+
245
+ HarmonAI IIIは、AI駆動の開発プロセスを実現する優れたスターターキットです。このテンプレートを基に、革新的なAIプロジェクトの開発を始めましょう!
docs/README.en.md ADDED
@@ -0,0 +1,245 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ <p align="center">
2
+ <img src="https://raw.githubusercontent.com/Sunwood-ai-labs/HarmonAI_III/refs/heads/main/docs/HarmonAI-III.png" width="100%">
3
+ <h1 align="center">🌟 HarmonAI III 🌟</h1>
4
+ </p>
5
+
6
+ <p align="center">
7
+ <a href="https://github.com/Sunwood-ai-labs/HarmonAI_III">
8
+ <img alt="GitHub Repo" src="https://img.shields.io/badge/github-HarmonAI__III-blue?logo=github">
9
+ </a>
10
+ <a href="https://github.com/Sunwood-ai-labs/HarmonAI_III/blob/main/LICENSE">
11
+ <img alt="License" src="https://img.shields.io/github/license/Sunwood-ai-labs/HarmonAI_III?color=green">
12
+ </a>
13
+ <a href="https://github.com/Sunwood-ai-labs/HarmonAI_III/stargazers">
14
+ <img alt="GitHub stars" src="https://img.shields.io/github/stars/Sunwood-ai-labs/HarmonAI_III?style=social">
15
+ </a>
16
+ <a href="https://github.com/Sunwood-ai-labs/HarmonAI_III/releases">
17
+ <img alt="GitHub release" src="https://img.shields.io/github/v/release/Sunwood-ai-labs/HarmonAI_III?include_prereleases&style=flat-square">
18
+ </a>
19
+ <a href="https://github.com/Sunwood-ai-labs/HarmonAI_III/graphs/commit-activity">
20
+ <img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/m/Sunwood-ai-labs/HarmonAI_III">
21
+ </a>
22
+ <a href="https://github.com/Sunwood-ai-labs/HarmonAI_III/pulls">
23
+ <img alt="PRs Welcome" src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square">
24
+ </a>
25
+ <img alt="GitHub repo size" src="https://img.shields.io/github/repo-size/Sunwood-ai-labs/HarmonAI_III">
26
+ <img alt="Development Status" src="https://img.shields.io/badge/status-active-success.svg">
27
+ <a href="https://github.com/Sunwood-ai-labs/HarmonAI_III/issues">
28
+ <img alt="GitHub issues" src="https://img.shields.io/github/issues/Sunwood-ai-labs/HarmonAI_III">
29
+ </a>
30
+ <a href="https://github.com/Sunwood-ai-labs/HarmonAI_III/network/members">
31
+ <img alt="GitHub forks" src="https://img.shields.io/github/forks/Sunwood-ai-labs/HarmonAI_III?style=social">
32
+ </a>
33
+ <a href="https://github.com/Sunwood-ai-labs/HarmonAI_III/watchers">
34
+ <img alt="GitHub watchers" src="https://img.shields.io/github/watchers/Sunwood-ai-labs/HarmonAI_III?style=social">
35
+ </a>
36
+ <img alt="GitHub last commit" src="https://img.shields.io/github/last-commit/Sunwood-ai-labs/HarmonAI_III">
37
+ <img alt="GitHub top language" src="https://img.shields.io/github/languages/top/Sunwood-ai-labs/HarmonAI_III">
38
+ <a href="https://github.com/Sunwood-ai-labs/HarmonAI_III/graphs/contributors">
39
+ <img alt="GitHub contributors" src="https://img.shields.io/github/contributors/Sunwood-ai-labs/HarmonAI_III">
40
+ </a>
41
+ <a href="https://github.com/Sunwood-ai-labs/HarmonAI_III/issues?q=is%3Aissue+is%3Aclosed">
42
+ <img alt="GitHub closed issues" src="https://img.shields.io/github/issues-closed/Sunwood-ai-labs/HarmonAI_III">
43
+ </a>
44
+ <a href="https://github.com/Sunwood-ai-labs/HarmonAI_III/pulls?q=is%3Apr+is%3Aclosed">
45
+ <img alt="GitHub closed PRs" src="https://img.shields.io/github/issues-pr-closed/Sunwood-ai-labs/HarmonAI_III">
46
+ </a>
47
+ <img alt="GitHub language count" src="https://img.shields.io/github/languages/count/Sunwood-ai-labs/HarmonAI_III">
48
+ <img alt="GitHub search hit counter" src="https://img.shields.io/github/search/Sunwood-ai-labs/HarmonAI_III/goto">
49
+ <img alt="GitHub code size" src="https://img.shields.io/github/languages/code-size/Sunwood-ai-labs/HarmonAI_III">
50
+ <a href="https://github.com/Sunwood-ai-labs/HarmonAI_III/blob/main/CONTRIBUTING.md">
51
+ <img src="https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg" alt="Contributor Covenant">
52
+ </a>
53
+ <a href="https://twitter.com/intent/tweet?text=Check%20out%20this%20awesome%20project%3A&url=https%3A%2F%2Fgithub.com%2FSunwood-ai-labs%2FHarmonAI_III">
54
+ <img alt="Twitter" src="https://img.shields.io/twitter/url?style=social&url=https%3A%2F%2Fgithub.com%2FSunwood-ai-labs%2FHarmonAI_III">
55
+ </a>
56
+ <img alt="GitHub Created At" src="https://img.shields.io/github/created-at/Sunwood-ai-labs/HarmonAI_III">
57
+ <a href="https://github.com/Sunwood-ai-labs/HarmonAI_III/deployments">
58
+ <img alt="GitHub deployments" src="https://img.shields.io/github/deployments/Sunwood-ai-labs/HarmonAI_III/Production">
59
+ </a>
60
+ <a href="https://github.com/Sunwood-ai-labs/HarmonAI_III/discussions">
61
+ <img alt="GitHub Discussions" src="https://img.shields.io/github/discussions/Sunwood-ai-labs/HarmonAI_III">
62
+ </a>
63
+ <img alt="GitHub followers" src="https://img.shields.io/github/followers/Sunwood-ai-labs?style=social">
64
+ <img alt="GitHub Release Date" src="https://img.shields.io/github/release-date/Sunwood-ai-labs/HarmonAI_III">
65
+ <img alt="GitHub commit activity (branch)" src="https://img.shields.io/github/commit-activity/y/Sunwood-ai-labs/HarmonAI_III/main">
66
+ <img alt="GitHub commits since latest release (by date)" src="https://img.shields.io/github/commits-since/Sunwood-ai-labs/HarmonAI_III/latest">
67
+
68
+
69
+ </a>
70
+ </p>
71
+
72
+ <p align="center">
73
+ <a href="https://github.com/Sunwood-ai-labs/HarmonAI_III/actions/workflows/generate-release-notes.yml">
74
+ <img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/Sunwood-ai-labs/HarmonAI_III/generate-release-notes.yml?label=generate-auto-release-notes">
75
+ <a href="https://github.com/Sunwood-ai-labs/HarmonAI_III/actions/workflows/translate-readme.yml">
76
+ <img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/Sunwood-ai-labs/HarmonAI_III/generate-release-notes.yml?label=auto-translate-readme">
77
+ <a href="https://github.com/Sunwood-ai-labs/HarmonAI_III/actions/workflows/issue-review.yml">
78
+ <img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/Sunwood-ai-labs/HarmonAI_III/generate-release-notes.yml?label=auto-issue-review">
79
+ </p>
80
+ <h2 align="center">
81
+ ~ AI-Powered Automated Repository Management Template ~
82
+
83
+ <a href="https://github.com/Sunwood-ai-labs/HarmonAI_III/blob/main/README.md"><img src="https://img.shields.io/badge/ドキュメント-日本語-white.svg" alt="JA doc"/></a>
84
+ <a href="https://github.com/Sunwood-ai-labs/HarmonAI_III/blob/main/docs/README.en.md"><img src="https://img.shields.io/badge/english-document-white.svg" alt="EN doc"></a>
85
+ </h2>
86
+
87
+ > [!IMPORTANT]
88
+ > HarmonAI III is a template repository developed using [cline (formerly Claude Dev)](https://github.com/clinebot/cline), [SourceSage](https://github.com/Sunwood-ai-labs/SourceSage), and [claude.ai](https://claude.ai/). The majority of release notes, README, and commit messages are generated using the latest AI technologies.
89
+
90
+ ## 🚀 Project Overview
91
+
92
+ HarmonAI III is an innovative **AI repository starter kit** integrating AIRA and IRIS. This repository aims to dramatically improve developer efficiency by providing the structure and workflow for AI development projects leveraging LLMs. Version: `v1.2.0`
93
+
94
+
95
+ ## 🆕 Latest News
96
+
97
+ - 🎉 v1.2.0 released: Added GitHub Shields to the README, added collaborator invitation functionality, and updated documentation.
98
+
99
+
100
+ ## ✨ Key Features
101
+
102
+ 1. **Integrated AI Toolset**: Provides the functionality of AIRA and IRIS in a single package.
103
+ 2. **Ready to Use**: Easily create a repository with a high-quality initial structure by using it as a template.
104
+ 3. **Automated Development Workflow**: Automates commit message generation, release note creation, and issue management.
105
+ 4. **Multilingual Support**: Supports international project deployment through automatic README translation.
106
+ 5. **Flexible Customization**: Easily adaptable to the needs of your project.
107
+ 6. **Automated Collaborator Invitation**: Collaborator invitation script using the GitHub API.
108
+
109
+
110
+ ## 🔧 How to Use
111
+
112
+ ### AIRA Example:
113
+ ```bash
114
+ aira --mode sourcesage commit --config=.aira\config.dev.commit.yml --ss-model-name="gpt-4o-mini" --llm-output="llm_output.md"
115
+ ```
116
+
117
+ ### IRIS Example:
118
+
119
+ Refer to the documentation for each component for detailed usage instructions.
120
+
121
+
122
+ ## 📦 Installation Instructions
123
+
124
+ 1. Use this repository as a template to create a new repository.
125
+ 2. Clone the repository locally.
126
+ 3. Install the necessary dependencies:
127
+ ```bash
128
+ pip install -r requirements.txt
129
+ ```
130
+ 4. Customize the AIRA and IRIS configuration files.
131
+ 5. Check the GitHub Actions settings and configure environment variables as needed.
132
+ 6. Open the `.github/release_notes/.sourcesage_releasenotes_iris.yml` file and change the value of `repo-name:` to your new repository name.
133
+
134
+
135
+ ## 🌿 Setting up the Environment
136
+
137
+ Follow these steps to set up the HarmonAI III environment:
138
+
139
+ 1. Create a virtual environment:
140
+ ```bash
141
+ python3 -m venv .venv
142
+ ```
143
+ This creates a virtual environment in the `.venv` directory.
144
+
145
+ 2. Activate the virtual environment:
146
+ ```bash
147
+ source .venv/bin/activate # Linux/macOS
148
+ .venv\Scripts\activate # Windows
149
+ ```
150
+
151
+ 3. Install dependencies:
152
+ ```bash
153
+ pip install -r requirements.txt
154
+ ```
155
+
156
+ These steps will prepare your development environment for HarmonAI III.
157
+
158
+
159
+ ## 📚 Main Components
160
+
161
+ ### 🤖 [AIRA (AI-Integrated Repository for Accelerated Development)](https://github.com/Sunwood-ai-labs/AIRA)
162
+ - Automated repository creation
163
+ - Automated commit message generation
164
+
165
+ ### 🌈 [IRIS (Intelligent Repository Issue Solver)](https://github.com/Sunwood-ai-labs/IRIS)
166
+ - Automated issue classification
167
+ - Automated solution suggestions
168
+ - Automated release note generation
169
+ - Automated README translation
170
+
171
+ ## 🤝 Automated Collaborator Invitation
172
+
173
+ HarmonAI III includes a script to automatically invite collaborators to the GitHub repository. Use it as follows:
174
+
175
+ 1. Create a `.env` file and set the necessary tokens:
176
+ ```
177
+ # GitHub access token (for collaborator invitation)
178
+ GITHUB_TOKEN=your_github_personal_access_token_here
179
+
180
+ # The following are examples of tokens that may be used by other functions. It's convenient to list them for later use.
181
+ # GITHUB_ACCESS_TOKEN=ghp_xxxxx
182
+ # YOUR_PERSONAL_ACCESS_TOKEN_IRIS=ghp_yyyyy
183
+ # GEMINI_API_KEY=AIzzzzz
184
+ ```
185
+
186
+ Note: Include the `.env` file in `.gitignore` to prevent it from being committed to the repository.
187
+
188
+ 2. Run the following command to invite a collaborator:
189
+ ```bash
190
+ python .github/github_add_collaborator.py Sunwood-ai-labs/HarmonAI_III username_to_invite
191
+ ```
192
+
193
+ Replace `username_to_invite` with the GitHub username you want to invite.
194
+
195
+ 3. Once the script runs successfully, a collaborator invitation will be sent to the specified user.
196
+
197
+ Cautions:
198
+ - This script requires the GitHub token to have appropriate permissions (the `repo` scope).
199
+ - When using it for an organization's repository, ensure that appropriate permissions are granted in the organization's settings.
200
+ - For security reasons, update tokens regularly and grant only the minimum necessary permissions.
201
+ - Never commit information including the `.env` file or tokens to a public repository.
202
+
203
+ This feature simplifies the process of adding new contributors to the project. You can efficiently expand your team while maintaining security.
204
+
205
+ ## 🐈 Process Flow
206
+
207
+
208
+ ```mermaid
209
+ %%{init:{'theme':'base','themeVariables':{'primaryColor':'#024959','primaryTextColor':'#F2C335','primaryBorderColor':'#F2AE30','lineColor':'#A1A2A6','secondaryColor':'#593E25','tertiaryColor':'#F2C335','noteTextColor':'#024959','noteBkgColor':'#F2C335','textColor':'#024959','fontSize':'18px'}}}%%
210
+
211
+ graph LR
212
+ A[Start] --> B[Repository Conception and Naming]
213
+ B -->|Human Action| C[HarmonAI III Repository Initialization]
214
+ C -->|Automated| D[Development Work]
215
+ D -->|Human Action| E[AIRA Automated Commits]
216
+ E --> H[IRIS Release Note Generation]
217
+ H --> I[IRIS Documentation Translation]
218
+ I --> J[Release]
219
+ J --> K[End]
220
+
221
+ class B,D,G human;
222
+ class E aira;
223
+ class F,H,I iris;
224
+ class C auto;
225
+ class A,J,K process;
226
+
227
+ ```
228
+
229
+
230
+
231
+ ## 🤝 Contributions
232
+
233
+ HarmonAI III welcomes contributions from the community as an open-source project. Help improve this template repository through bug reports, feature requests, and pull requests.
234
+
235
+ ## 📄 License
236
+
237
+ HarmonAI III is released under the [MIT License](LICENSE).
238
+
239
+ ## 🙏 Acknowledgments
240
+
241
+ HarmonAI III has been inspired by many open-source projects. We especially thank the developers of AIRA and IRIS. We also thank iris-s-coon and Maki.
242
+
243
+ ---
244
+
245
+ HarmonAI III is an excellent starter kit for achieving an AI-driven development process. Let's start developing innovative AI projects based on this template!
requirements.txt ADDED
@@ -0,0 +1,2 @@
 
 
 
1
+ aira
2
+ sourcesage