11.SakuraEditor_PRGuide

sakura-editor ProjectにおけるPRのガイドラインです。 ただしこのガイドラインは必須ではなく最初に参加されるときの参考にしていただければと思います。

尚、addするファイルは原則UTF-8(BOM付)でお願いします。

• 準備 (最初に一回だけ行うこと)

  • GitHub アカウントを作る
  • GitHub for Windows をインストールする
  • (オプション) Python をインストールする
  • Fork する
  • appveyor アカウントを作る
  • appveyor アカウントに 'sakura' のプロジェクトを GitHub のプロジェクトの中から追加する

• 準備 (作業を開始する前に行うこと)

  • 自分の Fork を最新の upstream に同期する
  • 自分の Fork 上にリモートブランチを作成する

• 修正

  • 適用したい修正をローカルで行いテストして(自分の Forkの リモートブランチと同名の)ローカルブランチにコミットする
  • 自分の Fork のリモートブランチに push する
  • 自分の appveyor アカウントでビルドに通ることを確認する。

• GitHub の Web site から PR を送る

  • マージを目的とした PR なのか、テストのための PR (= WIP [Work In Progress]) なのかの区別
  • 機能追加の場合
    • 追加する機能の説明
    • もし何かのトレードオフやデメリット等あればその説明
  • バグ修正の場合
    • 再現手順、発生条件等
    • バグの原因
    • バグの修正方法に関する説明
    • workaround なのか根本解決なのか等の位置づけ

• PR時連動するCI動作について

  • AppVeyor 関連について
  • Azure Pipeline 関連について