Skip to content

Latest commit

 

History

History
29 lines (23 loc) · 2.75 KB

CONTRIBUTING.md

File metadata and controls

29 lines (23 loc) · 2.75 KB
Raw

コントリビューションガイドライン (不具合報告や改善要望などについて)

Issue や Pull Request の作成は大歓迎です！

改善要望を送りたい！ (Discussion について)

不具合報告を送りたい！ (Issue について)

  • 不具合については Issue の作成にご協力ください。Issue の説明欄に入力する文章のフォーマットは自由ですが、提案の背景や内容を具体的に記入しただけますと対応がスムーズになります。Issue の作成には GitHub アカウントの作成が必要です。
  • Issue を作成せずに Pull Request を作成していただいても構いません
    • ただし、内容によっては Pull Request をマージせず Close させていただく場合があります。誤字脱字や明らかな不具合の修正ではない場合、機能修正の提案という形で Issue を作成していただけると、Pull Request がマージされないという事態を防げるかと思います。

PortalDots のコードを直接修正したい！ (Pull Request について)

  • Pull Request のベース（マージ先）ブランチは、基本的には 4.x としてください。
  • 下記の場合、Pull Request の作成前に PortalDots の開発者までご相談ください。
    • マイグレーションファイルを新規作成した場合
    • UI上のデザインや大幅な文言修正を行なった場合（誤字脱字の修正・軽微な修正以外）

開発の流れ (一例)

  1. このリポジトリを Fork した上で Clone する。
  2. ベースブランチから、Pull Request 提出用のブランチを作成する (命名規則 : feature/{issue番号}_{スネークケースでの説明} )。
    • e.g. feature/13_update_readme
  3. 開発を行う。
    • コミットの粒度、コミットメッセージの書き方は自由です。
  4. Pull Request を提出する。

コントリビューター行動規範

PortalDots では「コントリビューター行動規範」を定めています。Issue や Pull Request の作成前に一読していただけますと幸いです。