diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..1fd69b9 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,13 @@ +## 何を変えたか + + +## なぜ + + +## どう確かめたか + +- [ ] ローカルでテストが通った +- [ ] 画面を実際に操作して確認した(UI の変更がある場合) +- [ ] 本番・staging の設定や秘密の変更有無を記載した(秘密の値は書かない) + +## レビューで見てほしいところ diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..751db83 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,32 @@ +# .github + +Repo-specific delta only. The global baseline is inherited; do not repeat it here. + +## Scope + +CyberticalAI organization の default community health files(`SECURITY.md`、`.github/pull_request_template.md`)を置く public リポ。適用条件は README の GitHub 公式文書を参照する。 + +## Paths + +- `SECURITY.md` / `.github/pull_request_template.md` は org 全体へ継承される。`AGENTS.md` / `CODEOWNERS` / `README.md` はこのリポだけのもの + +## Commands + +- install / build: N/A(Markdown だけのリポ) +- CI: `.github/workflows/docs.yml` が README と SECURITY の存在・リンク、変更行を検査する + +## Constraints + +- public リポ。`README.md` の「編集にあたって」にある項目(社内チャンネル名・社内 URL、稼働中の検査構成やセキュリティツールの具体的な設定、個別リポジトリ名、個人のメールアドレス)を書かない +- 継承されるファイルを足したり外したりしたら、`README.md` の適用範囲の表も同じ変更で直す + +## Verification + +- PR の `docs` チェックを通し、GitHub 上で Markdown の表示を確認する + +## Delivery + +- 正本ブランチは `main`。merge した時点で、同名ファイルを持たない org 内のリポに適用される。デプロイ手順は無い +- 受入確認: 自前のテンプレートを持たない org 内のリポで PR を新規作成し、本文にテンプレートが入ることを見る + +Keep this file under 200 lines and 16 KiB. Put multi-step or occasional procedures in docs or a task-specific Skill. diff --git a/CODEOWNERS b/CODEOWNERS new file mode 100644 index 0000000..8e09693 --- /dev/null +++ b/CODEOWNERS @@ -0,0 +1,2 @@ +# 既定の担当者。ディレクトリごとに分けるときは下に行を足す。 +* @Nicolas0315 diff --git a/README.md b/README.md index bc9a102..7acf753 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,14 @@ 株式会社サイバーティカル(CyberticalAI organization)の **default community health files** を置くリポジトリです。 -ここに置いたファイルは、同じ organization が所有する全リポジトリ(private を含む)のうち、**自前の同名ファイルを持たないもの** に自動で適用されます。GitHub の仕様上、この機能を有効にするには本リポジトリが public である必要があります。 +ここに置いたファイルは、同じ organization が所有するリポジトリのうち、**自前の同名ファイルを持たないもの** に自動で適用されます。GitHub の仕様上、この機能を有効にするには本リポジトリが public である必要があります。 + +適用条件と配置場所は GitHub の[既定コミュニティファイルの説明](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)に従います。ここでは `.github/pull_request_template.md` を使います。 | ファイル | 適用範囲 | | --- | --- | | [`SECURITY.md`](./SECURITY.md) | 脆弱性の報告経路と対応の目安 | +| [`.github/pull_request_template.md`](./.github/pull_request_template.md) | PR 本文の既定(何を・なぜ・どう確かめたか)。自前の PR テンプレートを持たないリポで、PR 作成時に本文へ入る | ## 編集にあたって @@ -21,4 +24,4 @@ ## 個別リポジトリで上書きしたいとき -そのリポジトリのルートに `SECURITY.md` を置けば、そちらが優先されます。社内情報を含む完全版を使いたい場合はこの方法を取ってください。 +そのリポジトリのルートに `SECURITY.md` を置けば、そちらが優先されます(PR テンプレートも同じで、リポ側に `.github/pull_request_template.md` などがあればそちらが使われます)。社内情報を含む完全版を使いたい場合はこの方法を取ってください。