CONTRIBUTING

事前準備

  1. GitHubのアカウントをつくり、サインインする
  2. チーム規約のファイル群xerosbaseball/termsを、自分のアカウントにフォーク(コピー)する
    1. xerosbaseball/termsにアクセスする
    2. Forkボタンを押す Fork Fork
    3. 名前が[自分のアカウント名]/termsであることを確認して、Create forkボタンを押す Create fork Create fork

修正の出し方

  1. Issueに課題について記載する
    1. xerosbaseball/termsにアクセスする
    2. Issuesボタンを押す Fork Fork
    3. New issueボタンを押す Fork Fork
    4. Get startedボタンを押す Fork Fork
    5. テンプレートが開くので、タイトルと内容を編集してSubmit new issueボタンを押す Fork Fork
    6. Issueにコメントを皆で書いて解決すべき課題はなにか明らかにする 目の前におきた現象をそのまま解決すべき課題と信じ込んでしまうことが多く見られます。 また、課題と改善の議論が同時に行われ解決に直接関係ない改善を実施しようとすることもありました。まずは、目の前に発生した現象が実際に自分たちにどのような悪影響が出ているのか明らかにします。その後、具体的な悪影響が出ていることがわかった時点で初めてこの現象は解決すべき課題であり、具体的な改善策について話し合います。意見を記入したらCommentボタンを押します。 Fork Fork
  2. 修正する
    1. contentディレクトリの下にあるファイルがこのページを含むコンテンツです。これらのファイルを修正します。なお、.mdの拡張子がついているファイルはマークダウン記法で記載しています。
    2. 対象ファイルのページで編集ボタン(ペンのアイコン)を押し、内容編集する Fork Fork
    3. 編集したらPropose changeを押す Fork Fork
  3. プルリクエストを作成する
    1. 修正が終わったら編集の取り込みを依頼しますこれをプルリクエストといいます。Create pull requestを押します。詳細はプルリクエストとはとGitHubの公式ドキュメントも合わせて参照してくださいpull request の作成 Fork Fork
  4. 修正が取り込まれる
    1. プルリクエストに対してコメントが付いた場合は修正してください。
    2. textlintも使用していますので、textlintから指摘を受けた場合はこちらもすべて修正します。他にもtextlintも参考になります。textlintについてあなたが疑問に思ったことはほぼすべてネットに書いてあるのでGoogle等の検索エンジンを使うと解決できます。
    3. レビュアによって修正が承認されると、修正が取り込まれます。修正が取り込まれると自動でサイトは更新される仕組みになっていますのでしばらくお待ち下さい。GitHubのActionsタブから更新状況を確認できます。
    4. 修正が取り込まれたらIssueに当該プルリクエストのリンクをコメントで追加してクローズします。

プルリクエストの修正

レビューの指摘やtextlintの指摘を受けてプルリクエストの修正する場合は、プルリクエストを提出したブランチに対して修正を加えます。 コマンドラインが使用できる場合はレビューとマージを参考にします。 また、ブラウザしか使用できない場合はファイルを編集する を参考に修正します。 スマートフォンを修正対象のファイルを開きブランチを指定してから修正します。 edit_from_browser width=“320” height=“640” edit_from_browser width=“320” height=“640”