メインコンテンツまでスキップ

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

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

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

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

テンプレート追加の手順

1. テンプレートを作成する

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

2. リポジトリを準備する

  1. [フォークを作成]
    pdfmeリポジトリの右上にあるForkボタンをクリックして、あなたのGitHubアカウントにコピーします

  2. [ローカルにクローン]
    ターミナルで実行します(YOUR-GITHUB-USERNAMEをあなたのGitHubユーザー名に置き換えてください):

    git clone git@github.com:YOUR-GITHUB-USERNAME/pdfme.git
    cd pdfme
  3. [ブランチを作成]
    新しいブランチを作成します(例:テンプレート名my-new-templateを使用):

    git checkout -b add-my-new-template

3. テンプレートファイルを追加する

  1. [ディレクトリを作成]
    kebab-caseで新しいディレクトリを作成します(例:my-new-template):

    mkdir -p playground/public/template-assets/my-new-template
  2. [ファイルを配置]
    ダウンロードしたtemplate.jsonを新しいディレクトリに配置します
    (オプション)クレジットのためにauthorフィールドを追加します:

    {
    "author": "YOUR-GITHUB-USERNAME",
    "basePdf": ...
    }

参考:https://github.com/pdfme/pdfme/tree/main/playground/public/template-assets/invoice

4. 変更をコミットする

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

    git add .
    git commit -m "feat: Add My New Template"
  2. [GitHubにプッシュ]
    あなたのリポジトリにプッシュします:

    git push origin add-my-new-template

5. プルリクエストを作成する

  1. GitHubでPRを作成
    あなたのリポジトリページに移動 → Pull requestsNew pull request

  2. ブランチを選択

    • base repository:pdfme/pdfme(mainブランチ)
    • head repository:YOUR-GITHUB-USERNAME/pdfme(add-my-new-templateブランチ)
  3. 情報を入力

    • タイトル:Add [My New Template] template
    • テンプレートの特徴とユースケースの簡単な説明を含める
  4. PRを送信
    Create pull requestをクリックして完了!

6. マージを待つ

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

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

サポートが必要ですか?

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