テンプレート貢献ガイド ❤️
あなたのテンプレートをpdfmeのサンプルテンプレートに追加しましょう!
テンプレート一覧ページはpdfme.comの最も重要なページの一つで、新しいユーザーが要件に合ったテンプレートを見つけて時間を節約できるように作られています。
テンプレートを追加することで、pdfmeコミュニティに貢献できます。
テンプレートの追加にはGitHubのプルリクエストを使用します - ビルドやコード変更は必要ありません。
OSSへの貢献が初めてでも、このガイドに従うことで簡単に貢献できます。
テンプレート追加の手順
1. テンプレートを作成する
テンプレートデザイナーでテンプレートをデザインし、DL Template
ボタンを使ってtemplate.json
をダウンロードします
2. リポジトリを準備する
-
[フォークを作成]
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
3. テンプレートファイルを追加する
-
[ディレクトリを作成]
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": ...
}
参考:https://github.com/pdfme/pdfme/tree/main/playground/public/template-assets/invoice
4. 変更をコミットする
-
[変更を記録]
ターミナルで実行します:git add .
git commit -m "feat: Add My New Template" -
[GitHubにプッシュ]
あなたのリポジトリにプッシュします:git push origin add-my-new-template
5. プルリクエストを作成する
-
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
をクリックして完了!
6. マージを待つ
メンテナーのレビュー後、あなたのテンプレートがマージされ、正式に掲載されます 🎉
(修正が必要な場合は、GitHubでコメントを受け取ります)
ありがとうございます!あなたの貢献はpdfmeのコミュニティに大きな影響を与えます 🚀
サポートが必要ですか?
質問がある場合は、Discord #template-contributionでスクリーンショットと共に質問すると、スムーズにサポートを受けられます!