はじめての Pull Request

はじめに

• GitHub 上には、たくさんの素晴らしい Open Source Product があります
• それらの document には、結構な頻度で typo やコピペミスなどを見かけます
• 些細なことだし、なんて言わずに貢献してみましょう
• Pull Request の方法については他の方々のわかりやすい記事がたくさんあります
  • でも、実際の Open Source Product に対して出してみたので、あえて書いてみました
  • 対象は Asciidoctor という、文書作成 tool の README 部分です

手順

対象の repository を Fork する

Fork した repository 上で編集

clone

$ git clone "Fork した repository"

branch 作成と checkout

• この例では "modifytypo" という名前にした

$ git checkout -b modifytypo

編集して、該当の branch を commit, push

$ git add .

$ git commit

$ git push origin modifytypo

Pull Request の作成開始

自分の repository 上で、 "Compare & pull request" を押す

Comment を記入して、 Pull Request を作成

• 画面の下のほうで、修正点を確認する

• Comment 入力後、 "Create pull request" を押して Pull Request を作成

作成された Pull Request

• こんな感じで、 committer の check 待ちになります

Merge された Pull Request

• この記事を書いてる間に、 Pull Request が採用されてました。早い！

まとめ

• Pull Request を作成するのは、思った以上に簡単です
• Code への貢献は敷居が高いかもしれませんが、 typo の修正などは誰でもできます
• 自分のできる範囲で、多くの人が使う Open Source Product に貢献できたら素敵ですね
• あと、自分が Contributors として表示されると、何となくうれしいですよね

参考

• 【GitHub】Pull Requestの手順 - Qiita