Skip to content
Public template

About

Philtzの新規リポジトリを始めるための共通テンプレートリポジトリです。

Resources

Stars

2 stars

Watchers

0 watching

Forks

Latest commit

 

History

35 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

philtzjp/startingpoint

startingpoint は、Philtz の新規リポジトリを始めるための共通テンプレートです。

startingpoint is a shared template for starting new Philtz repositories.

テンプレートに入れるのは、リポジトリに置くしかないものだけです。手順や規約は写すと古くなるので、次の正本から読みます。

内容 正本
エージェントが作業前に読む手順 このリポジトリの START.md
Git と GitHub の規約、日本語の書き方など philtzjp/skills のスキル
Issue と PR のテンプレート philtzjp/.github の org の既定
Issue、PR、コミットメッセージの書式 philtzjp/.github の conventions.yml

Philtz のリポジトリで開発する人へ

使っているエージェント(Claude Code、Codex、Cursor など)に、次の文章をそのまま貼り付けてください。スキルの導入や Git の注意点は、エージェントが START.md を読んで対応します。AGENTS.md があるリポジトリでは、貼り付けなくてもエージェントが自分で読みます。

https://raw.githubusercontent.com/philtzjp/startingpoint/main/START.md を curl で取得して全文を読み、書かれている手順に従ってください。

Features

  • package.json: スキルを入れるコマンドを skills に置き、postinstall から呼ぶ。pnpm install のたびにスキルが最新になる。CI の中と .git のない場所では動かさない
  • AGENTS.md: START.md の正本を読む案内と、スキルを入れ直すコマンド。Claude Code は CLAUDE.md がなければ AGENTS.md を読むので、CLAUDE.md は置きません
  • .gitignore: リポジトリごとに入れたスキルをコミットしない設定
  • .vite-hooks/: pre-commit、pre-push、commit-msg の git hook。git config core.hooksPath .vite-hooks で有効になります。commit-msg は、conventions スキルの検査器を呼んで正本の規約で検査します

Usage

新しいリポジトリは philtzjp/pulumi の宣言から作ります。このテンプレートから作ったリポジトリでは、次を確認してください。

  • 入れるスキルを足すときは、package.json の skills に -s <スキル名> を足すこと。pnpm init は使わず、このファイルに依存を足していくこと

  • リポジトリ固有の規約があれば、AGENTS.md の案内の下に書くこと

  • リポジトリ固有のスキルをコミットするときは、.gitignore を次のように書き換え、固有のスキルだけを戻すこと

    .agents/skills/*
    !.agents/skills/<固有のスキル名>/
    .claude/skills/*
    !.claude/skills/<固有のスキル名>
    skills-lock.json
  • 適用するライセンスや権利表示を決め、必要なら LICENSE を足すこと。このテンプレートは LICENSE を含みません

  • git config core.hooksPath .vite-hooks を実行して git hook を有効にすること。clone ごとの設定なので、作業環境を作るたびに実行します

Repository Structure

.
├── .vite-hooks/
│   ├── commit-msg   # conventions スキルの検査器で、コミットメッセージを正本の規約で検査
│   ├── pre-commit   # 暗号化されていない .env* の混入を検査
│   └── pre-push     # リモートの状態が古いまま push するのを防ぐ
├── .gitignore       # リポジトリごとに入れたスキルを無視する
├── AGENTS.md        # START.md を読む案内と、スキルを入れ直すコマンド
├── package.json     # skills にスキルを入れるコマンド。postinstall から呼ぶ
├── README.md
└── START.md         # エージェントが作業前に読む手順の正本。テンプレートから作るときには写さない

Rights

このテンプレートにはライセンスファイルを含めていません。テンプレートから作成したリポジトリに、意図しないライセンスがそのまま付くのを防ぐためです。

作成先リポジトリに適用するライセンスや権利表示は、そのリポジトリ側で決めて明示してください。

About

Philtzの新規リポジトリを始めるための共通テンプレートリポジトリです。

Resources

Stars

2 stars

Watchers

0 watching

Forks

Contributors

Languages