Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
name: 不具合
about: 動かない・想定と違う挙動を報告する
labels: bug
---

<!--
書けるところだけで構いません。**このテンプレートは任意です。**
不要な見出しは消してください。

セキュリティに関する問題は、ここではなく Private vulnerability reporting へ。
→ SECURITY.md
-->

## 現象

<!-- 何が起きるか。エラー メッセージがあれば、そのまま貼ってください。 -->

## 環境

| | |
|---|---|
| バージョン | <!-- 例: OpenTouryo.Public 3.0.0 --> |
| ターゲット | <!-- net48 / net10.0。**両者は別実装の箇所があり、片方にしか無い問題があり得ます** --> |
| DBMS | <!-- 使っている場合 --> |

## 再現手順

<!--
1.
2.
3.
-->

## 期待する動作

## 調べたこと

<!-- 原因の見当や、切り分けの結果があれば。無くても構いません。 -->
16 changes: 16 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Issue テンプレートの設定
#
# blank_issues_enabled: true にしてあるため、**テンプレートは任意**である。
# 「Open a blank issue」から、素の Issue も起票できる。
#
# テンプレートを Markdown(.md)にしているのも、任意にするため。
# YAML フォーム(.yml)にすると必須項目を強制でき、書きたいことが書けなくなる。
blank_issues_enabled: true

contact_links:
- name: 脆弱性の報告(Security)
url: https://github.com/OpenTouryoProject/OpenTouryo/security/advisories/new
about: セキュリティに関する問題は、公開の Issue ではなく Private vulnerability reporting へ。SECURITY.md を参照。
- name: 質問・相談
url: https://github.com/OpenTouryoProject/OpenTouryo/issues?q=is%3Aissue
about: 同じ問題が既に挙がっていないか、先に検索してください。
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/enhancement.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
name: 機能追加・改善
about: 新しい機能や、既存機能の改善を提案する
labels: enhancement
---

<!--
書けるところだけで構いません。**このテンプレートは任意です。**
不要な見出しは消してください。
-->

## 何をしたいか

## なぜ必要か

<!-- 今それができないことで、何に困っているか。 -->

## 案

<!-- 複数あるなら、それぞれの利点と欠点を。1 つでも構いません。 -->

## 影響

<!--
**利用者に影響するか**を書いてください。ここが最も重要です。

・公開 API が変わるか(下位互換)
・ビルド時に警告が出るようになるか
・既定の挙動が変わるか
・net48 / net10.0 のどちらに効くか
-->
47 changes: 47 additions & 0 deletions .github/ISSUE_TEMPLATE/quality.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
name: 品質改善
about: リファクタリング、規約整備、CI・セキュリティの整備、文書の整理
labels: quality improvement
---

<!--
書けるところだけで構いません。**このテンプレートは任意です。**
不要な見出しは消してください。

「調査 → 実装 → 検証」の型で書くと追いやすくなります(#531 / #532 / #533 / #536)。
実施済みの内容を記録として起票する場合も、この型で構いません。
-->

## 概要

<!-- 何を、なぜ直すか。 -->

## 現状

<!--
**実測した値を書いてください。** 「多い」「遅い」ではなく件数や秒数で。
推測と事実を混ぜないこと。
-->

## 対応

<!-- 何をするか。複数の案があるなら、選んだ理由も。 -->

## 検証

<!--
変更したら、影響範囲に応じて通します(CHEATSHEET.md 1 節)。

.\1_BuildAll.ps1 -IgnoreErrors 'error MSB(3482|3325|3321):.*WSClientWinCone_sample\.csproj'
.\2_RunAllTests.ps1
.\3_SmokeTest.ps1

合格の目安は 全ステップ OK / 8-8 差分 0 / 22-22。
-->

## 利用者への影響

<!--
**無いなら「無し」と書いてください。** 空欄だと、確認したのか未確認なのか分かりません。
あるなら、リリース ノートから参照できるように具体的に。
-->
46 changes: 46 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
<!--
**このテンプレートは任意です。** 不要な見出しは消してください。
小さな変更なら、要約 1 行でも構いません。
-->

## 概要

<!-- 何を変えたか。関連する Issue があれば `#123` のように書いてください。 -->

## 変更内容

<!--
ファイル単位ではなく、**変更の意図**の単位で。

・net48 と net10.0 の両方に効くか
・公開 API を変えたか(下位互換)
-->

## 検証

<!--
影響範囲に応じて通します(CHEATSHEET.md 1 節)。**結果を貼ってください。**

.\1_BuildAll.ps1 -IgnoreErrors 'error MSB(3482|3325|3321):.*WSClientWinCone_sample\.csproj'
.\2_RunAllTests.ps1
.\3_SmokeTest.ps1

合格の目安は 全ステップ OK / 8-8 差分 0 / 22-22。
文書だけの変更なら「不要」と書いてください。
-->

## 利用者への影響

<!--
**無いなら「無し」と書いてください。** 空欄だと、確認したのか未確認なのか分かりません。

・公開 API の変更、ビルド警告が出るようになる変更、既定の挙動の変更
・NuGet パッケージに入るか(Frameworks/Infrastructure 配下か)
-->

---

<!--
**master 宛の PR は、レビュー 1 名の承認と CI(build、約 14 分)の成功が必要です。**
develop 宛には必須チェックはありません。
-->
34 changes: 34 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,23 @@ gh issue create --repo OpenTouryoProject/OpenTouryo --title <title> --body-file
- 本文は一時ファイルに書き、`--body-file` で渡す(改行・記号の欠落を避ける)
- 投稿後は URL を報告する

**テンプレートは自動では適用されない。読んで、その構成に沿って書くこと。**

`gh issue create` / `gh pr create` の `--template` は「エディタで編集する前提の
開始テキスト」であり、**`--body-file` と併用すると本文で上書きされる。**
エージェントは `--body-file` を使うため、テンプレートは効かない。

```
.github/ISSUE_TEMPLATE/bug.md 不具合
.github/ISSUE_TEMPLATE/enhancement.md 機能追加・改善
.github/ISSUE_TEMPLATE/quality.md 品質改善(リファクタリング・規約・CI・文書)
.github/pull_request_template.md PR
```

**テンプレートは任意**(`blank_issues_enabled: true`)だが、
**「利用者への影響」は、無いなら「無し」と明記する。**
空欄だと、確認したのか未確認なのかが読み手に分からない。

**このリポジトリでは `OsscJpDevInfra` アカウントを使用する。**
`gh auth status` に複数のアカウントが登録されていることがあるため、
投稿前にアクティブなアカウントを確認すること。異なる場合は `gh auth switch` で切り替える。
Expand All @@ -72,6 +89,23 @@ gh auth switch --user OsscJpDevInfra # 異なる場合は切り替え
**Issue のクローズ・ラベル変更・アサイン、PR の作成やマージは人が行う。**
これらは成果物の検収と同じ扱いとし、エージェントは提案に留める。

**PR のレビューは、`--comment` だけ行ってよい。**

| 操作 | 誰が行うか |
|---|---|
| `gh pr review --comment` | **エージェント可**(文面を提示し、承認を得てから) |
| `gh pr review --approve` / `--request-changes` | **人のみ。検収に当たる** |
| PR の作成・マージ | **人のみ** |

`--comment` は `COMMENTED` として記録され、**必須レビューを満たさない**。
`reviewDecision` は `REVIEW_REQUIRED` のまま変わらないので、
**マージを進めてしまう心配は無い。**

> **承認が必須レビューとして数えられるのは `write` 以上の人だけ。**
> 公開リポジトリなので誰でも `read` は持つが、それでは足りない。
> **自分が出した PR は、自分で承認できない。**
> レビュアーの構成は [`GitHubUsage.md`](GitHubUsage.md) 2 節。

### コーディング規約は CODING.md、領域ごとの事情は ANALYSIS.md に従う

**規約は全領域に共通、分析は領域ごと**に分かれている。
Expand Down
Loading