CONTRIBUTION_GUIDE.md

コントリビューション ガイド

本リポジトリへのコントリビューションに関心を持ってくださり、ありがとうございます。いただいたコントリビューションを受け入れる際に基準となるコントリビューションポリシーについて提示させていただきます。ご一読くださりますよう、よろしくお願いいたします。

• 機能リクエスト
• 不具合報告
• プルリクエストの作成について

すでに登録されている issue を対応いただくことも可能です。その際は、作業の重複を避けるため、着手した旨を告知してください。また、すでに作成されたプルリクエストがある場合、コミュニティによるレビューや、コメント、提案、追加のプルリクエストなどのコントリビューションを随時受け付けております。

以下に、いくつかのコントリビューションについて記載いたします。

機能リクエスト

もし機能リクエストがありましたら、下記のテンプレートを利用して issue を登録くださいますようお願いします。なお、起票する前に Issues ページをご確認いただき、同じ内容のリクエストがすでに挙がっていないか確認をお願いいたします。

• Feature request

また、他の issue にコメントする際は、尊重と思いやりのあるご対応をお願いいたします。

不具合報告

注: issue を登録する際は、クレデンシャルなどの機密情報を掲載しないようご注意ください。

不具合報告として issue を登録する際は、こちらのテンプレートをお使いください。対応する人が不具合をすばやく把握し対応できるように、より具体的な報告をお願いいたします。

• Bug report

なお、起票する前に下記のご確認をお願いいたします。

• Issues ページにて、同様の不具合がすでに登録されていないか確認して下さい。もし同様の不具合が登録されていましたら、新規の起票はせず、その issue に +1 （サムズアップのリアクション）を追加して報告としてください。
• コードを最新版にアップデートし、該当の不具合が修正されていないかどうか確認してください。
• issue 登録の際は上記のテンプレートを利用してください。

プルリクエストの作成について

プルリクエストを作成し、コントリビューションしていただくことも可能です。その際は下記手順を参考にご対応ください。

1. 本リポジトリをご自身のアカウントにフォークします

   フォークについては、リポジトリをフォークする - GitHub ヘルプ をご参照ください

2. フォーク先リポジトリをご自身の環境にクローンし、下記のように remote に upstream を設定してください

   # フォーク先リポジトリをフォークする
   git clone <フォークしたリポジトリのURL>
   
   # クローンしたディレクトリに移動する
   cd freee-accounting-sdk-php
   
   # remote に upstream という名前で登録する
   git remote add upstream <オリジナルのリポジトリのURL>

   もし、クローン後に時間がたってから作業を再開する場合は、 upstream から最新の更新を pull してください

   # upstream から pull する
   git pull upstream master

3. develop を作成し、更新を行います

   # develop ブランチを作成する
   git checkout -b master develop

4. 更新が終わったら、upstream の更新を develop ブランチにマージします

   # upstream を pull してマージする
   git pull upstream develop

5. フォーク先リポジトリに push します

   # フォーク先リポジトリに push する
   git push origin develop

6. フォーク先リポジトリの develop ブランチから、オリジナルのリポジトリの master ブランチに対してプルリクエストを作成します

   詳細は、プルリクエストについて - GitHub ヘルプ をご参照ください