Skip to content

Latest commit

 

History

History
42 lines (33 loc) · 2.67 KB

CONTRIBUTING.md

File metadata and controls

42 lines (33 loc) · 2.67 KB

Contribution Guide

このサイトはオープンソースにより開発されています。
みなさまのコントリビューションをお待ちしております。

Issue Guide

サイトの不具合や修正すべき箇所をみつけた場合は、Issueを送信してください。
あなたが解決できるIssueを見つけた場合は、その旨をコメントしてください。こちらでIssueにAssignいたします。(他の人と同じIssueへの作業をしてしまうことを防ぐためです。)

Pull-Requests Guide

自分が解決できるIssueがあれば、プルリクエストで修正をお送りください。
提出の際には、1つのIssueに1つのPRを対応させるよう心がけてください。

⚠️問題に対する議論の場を分散させないため、PRは必ず既存のIssueに基づいて作成してください。 修正したい箇所に対応するIssueが存在しない場合は、まずIssueの作成を検討してください。

変更の反映

各コミットにはLintに引っかかるエラーがないことを確認してください。
Lintはgit commitの際に自動で実行されるほか、手動で実行する(npm run lint)こともできます。自動で修正可能な問題はnpm run lintfixで修正することもできます。

upstreamの変更をローカルに反映させる場合は以下のようにしてローカルに変更を反映させてください。

git fetch upstream
git checkout master
git merge upstream/dev

プルリクエスト

プルリクエストはdevブランチに対して発行してください。
プルリクエストに不具合や修正すべき箇所がある場合には、コメント等でお伝えしますので、その箇所を修正し、あなたのリポジトリにコミット・プッシュしてください。新たなコミットの内容は自動的にプルリクエストに反映されます。

Rules for Commitments

コミットの際には以下のことを念頭に置いてください。

  • 必ず作業単位ごとにコミットし、複数の種別の変更を一つのコミットにしない。
  • 先頭にプレフィクスを以下の形式でつける
    • [Add] 新しいファイルや機能等の追加
    • [Update] 機能等の大きな更新
    • [Fix] 細かな不具合や見た目の修正
    • [Delete] ファイルや機能等の削除
    • [Chore] 本体に直接は関わらないツール等の変更
  • プレフィクスの後には日本語で簡潔にコミット内容を説明する
    • 例)[Add] ヘッダーの追加