Skip to content

Instantly share code, notes, and snippets.

@kenfdev

kenfdev/OpenFaaSコントリビューション.md

Last active January 13, 2019 13:47
Show Gist options
  • Save kenfdev/401af7daa92d20d8dde2812f7e2798cd to your computer and use it in GitHub Desktop.
Save kenfdev/401af7daa92d20d8dde2812f7e2798cd to your computer and use it in GitHub Desktop.
Download ZIP
Raw
OpenFaaSコントリビューション.md

OpenFaaS コントリビューションガイド

いろいろなコントリビューションの方法

はじめてのコントリビューション

CONTRIBUTING.md はしっかり読みましょー！！

PR（プルリクエスト）をしてマージしてもらうことだけがすべてじゃない！

その他コントリビューションできる方法

  • Go言語でコードを書く（OpenFaaSのコンポーネントはすべてGo言語で書かれています）
  • フロントエンドのコードを書く
  • functionを書いてみる（どんな言語でもOK。自分でtemplateを作ってみるのも面白い）
  • PR（プルリクエスト）をレビューしてみたり、テストしてみたり
  • 新機能を試してみて、フィードバックする
  • Meetupやカンファレンスで話す

主なリポジトリ

PR（プルリクエスト）までの流れ

「いいこと思いついた！よし、コードを書いてPR出して驚かせよう！」

という流れは基本的にリジェクトされてしまいます。まずはIssueをあげるか、Slackで話し合うかが重要です。なので、

  • Issueをあげる
  • 議論（デザインレビュー）して、実装の方針を決める
  • リポジトリをForkする
  • 実装する
  • PRを投げる
  • レビュー後、必要であれば修正する
  • マージされる

という流れになります。

コミット時の注意点

Gitのコミットには必ず DCO (Developer's Certificate of Origin - 開発者起源証明書) が必要になります。適切なオープンソースライセンスのもとで貢献することを承認した署名が必要です。これは、コミットメッセージに以下の文言を必ず加えることで署名したものとなります。

Signed-off-by: ＜名＞ ＜姓＞ <メール@email.com>

Gitで user.name と user.email を設定しておけば git commit に -s を加えるだけでOKです。

git commit -s

コミット時は必ずこれが必要です。ない場合はマージされません。

Issueにとりかかってみよう

Issueを探す

面白そうなお題

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment