Repository navigation
chore: チーム開発の標準ファイルを足す #1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
5775b67
chore: チーム開発の標準ファイルを足す (repo-standardize)
Nicolas0315 e063f5f
chore: 公開リポに検査設定を置かず、AGENTS.md と README の継承ファイル表を実態に合わせる
Nicolas0315 f40bb9a
Merge remote-tracking branch 'origin/main' into chore/repo-standard-2…
Nicolas0315 c579300
docs: describe organization docs check
Nicolas0315 fe1e4d3
docs: cite default template locations and private scope
Nicolas0315 b484617
docs: clarify default scope and keep secrets out of PR bodies
Nicolas0315 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| ## 何を変えたか | ||
| <!-- 画面・機能の単位で1〜3行。コードを読まない人にも分かる言葉で。 --> | ||
|
|
||
|
Nicolas0315 marked this conversation as resolved.
|
||
| ## なぜ | ||
| <!-- 関連する Issue・依頼・不具合。 --> | ||
|
|
||
| ## どう確かめたか | ||
| <!-- 動かした手順と結果。画面の変更はスクリーンショットか動画を貼る。 --> | ||
| - [ ] ローカルでテストが通った | ||
| - [ ] 画面を実際に操作して確認した(UI の変更がある場合) | ||
| - [ ] 本番・staging の設定や秘密の変更有無を記載した(秘密の値は書かない) | ||
|
|
||
| ## レビューで見てほしいところ | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 の表示を確認する | ||
|
Nicolas0315 marked this conversation as resolved.
|
||
|
|
||
| ## 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. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| # 既定の担当者。ディレクトリごとに分けるときは下に行を足す。 | ||
| * @Nicolas0315 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.