CONTRIBUTING.example.md

リポジトリ運用ガイドライン

プロジェクトに参加していただきありがとうございます。
このリポジトリを運用するにあたり、以下の項目をご確認いただけると幸いです。

Issue

• Issueの追加は、同様のものがないか確認してからお願いします。
• 1つのIssueには1つのタスクのみを含めるようにしてください。
• help wanted や high priority のラベルがついたIssueを優先していただけると幸いです。
• このリポジトリにまだ慣れていない方は、good first issue のラベルがついたIssueから対応することをおすすめします。
• pending のラベルがついたIssueは保留中なので、実装は避けてください。

Pull Request

• Issueへのリンクを記入するようお願いいたします。
• テストが通ることを確認してから Pull Request を作成してください。
• 見た目の変更がある場合はスクリーンショットを貼るようお願いいたします。
• 対応方法が不明な場合はIssueで相談してください。
• サポートが必要な場合は Draft Pull Request かIssueで相談してください。

開発環境構築手順

依存関係

• Node.js v10.16.0

コマンド

# 依存ライブラリのインストール
npm install

# デバッグビルド
npm run dev

# 本番ビルド
npm run build

# テスト
npm run test

開発フロー

1. Issueを作成する
2. ローカルのdevelopブランチで git pull を実行し、最新の状態にする
3. developブランチから作業用のブランチを作成する
4. 作業ブランチで作業を行う
5. 作業内容をcommitしてpushする
6. pushしたブランチからdevelopブランチに対するプルリクエストを作成する
7. レビューに対応する
8. レビュアーがマージする
9. リモート上の作業用ブランチを削除する

主なブランチ

• develop
  • デフォルトブランチ
  • 開発環境
  • 直接はコミットせず、プルリクエストを通す
• master
  • 本番環境
  • 直接はコミットせず、masterブランチからのプルリクエストを通す

ルール

• レビュアー
  • foo
  • bar
• マージ条件
  • テストが通る
  • レビュアーの1人が承認
• レビューコメント
  • レビュアーとレビュイーは共通の問題を解決するためのチームであることを意識し、互いに敬意を払う
  • 指摘には理由を含める
  • スタイルガイドに記載されていること以外にスタイルに関するコメントをしない
  • レビュアー以外もコメントして良い
  • マージ後にもコメントして良い
• その他
  • 1つのプルリクエストは1種類の変更のみを行って、できる限り小さくする

参考情報

• 開発者向けドキュメント
• プロジェクト情報