mirror of https://github.com/pdfme/pdfme.git synced 2026-06-19 11:49:16 -04:00

Files

Devin AI f557192d4e Complete Japanese translation of documentation files

Co-Authored-By: Kyohei Fukuda <kyouhei.fukuda0729@gmail.com>

2025-03-13 08:13:53 +00:00

テンプレート貢献ガイド ❤️

あなたのテンプレートをpdfmeのサンプルテンプレートに追加しましょう！
テンプレート一覧ページはpdfme.comの最も重要なページの一つで、新しいユーザーが要件に合ったテンプレートを見つけて時間を節約できるように作られています。

テンプレートを追加することで、pdfmeコミュニティに貢献できます。
テンプレートの追加にはGitHubのプルリクエストを使用します - ビルドやコード変更は必要ありません。

OSSへの貢献が初めてでも、このガイドに従うことで簡単に貢献できます。

テンプレート追加の手順

テンプレートデザイナーでテンプレートをデザインし、DL Templateボタンを使ってtemplate.jsonをダウンロードします

[フォークを作成]
pdfmeリポジトリの右上にあるForkボタンをクリックして、あなたのGitHubアカウントにコピーします
[ローカルにクローン]
ターミナルで実行します（YOUR-GITHUB-USERNAMEをあなたのGitHubユーザー名に置き換えてください）：
```
git clone git@github.com:YOUR-GITHUB-USERNAME/pdfme.git
cd pdfme
```
[ブランチを作成]
新しいブランチを作成します（例：テンプレート名my-new-templateを使用）：
```
git checkout -b add-my-new-template
```

[ディレクトリを作成]
kebab-caseで新しいディレクトリを作成します（例：my-new-template）：
```
mkdir -p playground/public/template-assets/my-new-template
```
- ディレクトリ名はテンプレート一覧ページでMy New Templateとして表示されます
[ファイルを配置]
ダウンロードしたtemplate.jsonを新しいディレクトリに配置します
（オプション）クレジットのためにauthorフィールドを追加します：
```
{
  "author": "YOUR-GITHUB-USERNAME",
  "basePdf": ...
}
```

[変更を記録]
ターミナルで実行します：

git add .
git commit -m "feat: Add My New Template"

[GitHubにプッシュ]
あなたのリポジトリにプッシュします：
```
git push origin add-my-new-template
```

GitHubでPRを作成
あなたのリポジトリページに移動 → Pull requests → New pull request
ブランチを選択
- base repository：pdfme/pdfme（mainブランチ）
- head repository：YOUR-GITHUB-USERNAME/pdfme（add-my-new-templateブランチ）
情報を入力
- タイトル：Add [My New Template] template
- テンプレートの特徴とユースケースの簡単な説明を含める
PRを送信
Create pull requestをクリックして完了！

メンテナーのレビュー後、あなたのテンプレートがマージされ、正式に掲載されます 🎉
（修正が必要な場合は、GitHubでコメントを受け取ります）

ありがとうございます！あなたの貢献はpdfmeのコミュニティに大きな影響を与えます 🚀

質問がある場合は、Discord #template-contributionでスクリーンショットと共に質問すると、スムーズにサポートを受けられます！