Skip to content

Conversation

@ikura-hamu
Copy link
Member

@ikura-hamu ikura-hamu commented Sep 19, 2025

PR Type

Documentation


Description

  • Copilotガイドを削除しAGENTS.md新設

  • 開発フロー/規約/落とし穴を追記

  • ディレクトリ構成と用語を整理

  • マイグレーション/生成手順を明確化


Diagram Walkthrough

flowchart LR
  Copilot[".github/copilot-instructions.md"] -- 削除 --> Repo["docs"]
  Agents["AGENTS.md"] -- 新規追加 --> Repo
  Agents -- 含む --> Arch["アーキテクチャ/開発手順/テスト/権限"]
Loading

File Walkthrough

Relevant files
Documentation
copilot-instructions.md
Copilot用ガイドの撤去                                                                                     

.github/copilot-instructions.md

  • 既存のCopilot向けガイドを全削除
  • リポジトリルートの新文書へ移行
+0/-139 
AGENTS.md
開発者向けエージェントガイドの新規追加                                                                           

AGENTS.md

  • アーキテクチャと依存注入の概要を追加
  • Taskベースの開発フローを記載
  • エンドポイント追加手順/Do&Dont追記
  • 用語集とディレクトリ構成を整理
+211/-0 

@github-actions
Copy link

Migrate lint ✅

Lint output

@github-actions
Copy link

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Recommended focus areas for review

タイポ/変数名不一致

テストコード例でスライス/マップの変数名がtestCasessと複数形の綴りミスになっており、下のループではtestCasesを参照しているため混乱を招く。読み手がコピペして失敗しないよう統一が必要。

testCasess := []struct{ 
    name string
    input X
    wantErr bool
  }{
	  {name: "ok", input: X{...}},
  	{name: "invalid id", input: X{...}, wantErr: true},
  }
for _, testCase := range testCases { t.Run(testCase.name, func(t *testing.T) { /* require/assert */ }) }

または

testCasess := map[string]struct{ 
    input X
    wantErr bool 
  }{
	  "ok": {input: X{...}},
	  "invalid id": {input: X{...}, wantErr: true},
  }
for name, testCase := range testCases { t.Run(name, func(t *testing.T) { /* require/assert */ }) }

</details>

<details><summary><a href='https://github.com/traPtitech/trap-collection-server/pull/1377/files#diff-a54ff182c7e8acf56acfd6e4b9c3ff41e2c41a31c9b211b2deb9df75d9a478f9R164-R186'><strong>用語の一貫性</strong></a>

OS名の表記ゆれ("Mac OS"ではなく"macOS"が一般的)や"Launcher Version"→"Edition"の移行に関する注釈の場所・表記の統一など、表記を揃えると混乱を防げる。
</summary>

```markdown
Windows 用の exe ファイルを含むもの、Mac OS 用のアプリケーションを含むもの、JVM 用の jar ファイルを含むものがある。

### game video

ゲームの動画。1つの game に複数の game video が存在する。

### game image

ゲームの画像。1つの game に複数の game image が存在する。

### game version

ゲームのバージョン。1つの game に複数の game version が存在する。
1つのバージョンには、1つ以上の game file または URL、1つの game video、1つの game image が含まれる。

### edition

ランチャーのエディション。複数の game version をまとめたもの。
エディションは、 game version をまとめて配布するためのもの。
例えば、x年のコミケ用のエディション、y年の工大祭用のエディションなど。
以前は Launcher Version と呼ばれており、一部にその名前が残っている。

### game role
権限説明の明確化

権限セクションで「権限は handler の checker で調べる」とあるが、具体的な参照箇所やインタフェース名が不明確。実装参照先の例(パッケージ/関数)を示すと運用が楽になる。

## 5. 権限/Visibility の要点

- Visibility(`public/limited/private`) はゲーム取得系でフィルタ必須。既存 handler/service を参照し同一条件を使い回す。
- Game Role: `owner` は削除/ロール管理まで、`maintainer` は編集/ファイル追加可。
- Admin: 全ゲーム操作 + Edition 作成権限。
- 権限は handler の checker で調べる。

@github-actions
Copy link

github-actions bot commented Sep 19, 2025

Migrate lint ✅

Lint output

@codecov
Copy link

codecov bot commented Sep 19, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 49.88%. Comparing base (bf2e25c) to head (817ec05).
⚠️ Report is 24 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1377      +/-   ##
==========================================
+ Coverage   49.73%   49.88%   +0.15%     
==========================================
  Files         134      134              
  Lines       11738    11738              
==========================================
+ Hits         5838     5856      +18     
+ Misses       5600     5581      -19     
- Partials      300      301       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@ikura-hamu ikura-hamu disabled auto-merge September 19, 2025 12:36
@ikura-hamu ikura-hamu merged commit 4a9012b into main Sep 19, 2025
11 checks passed
@ikura-hamu ikura-hamu deleted the docs/agents_md branch September 19, 2025 12:43
@ikura-hamu ikura-hamu mentioned this pull request Oct 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants