AGENTS.md
プロジェクト概要
Project SVG は、SVGファイルを入力として受け取り、RGBAバッファを生成する C++17 ライブラリである。
ディレクトリ構成
| ディレクトリ名 | 概要 |
|---|---|
.github | ワークフロー・PR雛形 |
docs | 開発ルールや関連資料 |
src | ライブラリ本体の実装 |
tests | 単体テストコード配置 |
third_party | 外部ライブラリ管理 |
tool | 軽微な補助ツール配置 |
参照ドキュメント
必須
作業前に以下を確認すること。
.github/PULL_REQUEST_TEMPLATE.mddocs/commit_guidelines.md
条件付き
C++コードを実装する場合
docs/coding_guidelines.md
テストコードを実装する場合
docs/test_coding_guidelines.md
PRのルール
- PR本文は
.github/PULL_REQUEST_TEMPLATE.mdのフォーマットに埋め込む形で出力すること。 - PRタイトルは
docs/commit_guidelines.mdを準拠して出力すること。 - PR本文内の見出しは
.github/PULL_REQUEST_TEMPLATE.mdを準拠すること。 - PR本文は日本語で出力すること。
- PRタイトルは日本語で出力すること。
コミット時のルール
- コミットメッセージは
docs/commit_guidelines.mdを準拠して出力すること。 - コミットメッセージは日本語で出力すること。
実装ルール
- C++17 準拠
- ヘッダと実装を分離する(
.h/.cpp) - インクルードガードは
#ifndef形式 - 命名規則は既存コードに合わせる
- 不要な依存を追加しない
- 既存コードの流儀に合わせる
作業時の基本
- 指示された範囲のみ変更する
- 関連のないファイルは変更しない
- 必要最小限の差分で対応する
- 不明点がある場合は推測で補完しない
作業後チェック
可能な範囲で以下を確認すること。
- ビルド確認
- 関連テストの実行
- 変更内容に不要な依存や副作用がないことの確認
出力ルール
回答には以下を含めること。
- 変更ファイル一覧
- 各ファイルの役割
- 実施内容の要約
- 必要に応じて日本語のコミットメッセージ案
- 必要に応じて日本語のPR本文案
禁止事項
- 仕様判断を行わない
- 設計判断を行わない
- 推測で補完しない
- 指示されていない大規模なリファクタを行わない
- 無関係な修正を行わない
- 仮実装で埋めない
- ダミー値で成立させない