貢献する

貢献のご検討ありがとうございます!支援にはたくさんの方法があります。

何に取り組むべきか

Screwdriver の全ての issue は、screwdriver repo にあります。私達が現在何に取り組んでいるかは、Screwdriver API repo の Projects にある digital scrum board をチェックしてください。どのリポジトリを変更すればよいか分からなければ、どこに貢献するかのドキュメントを参照してください。開発の指針に関しては、開発を開始するのドキュメントを確認してください。

貢献のための一般的なガイドライン

以下のようにお願いします。

プルリクエストを送る

バグ修正、機能追加、改善のパッチはプルリクエストとして受け付けています。以下は貢献する際の参考です。

大掛かりな改善に取り組むときは、それがプロジェクトの目標に沿うものか確認するために事前にお声掛けください。

コミットメッセージのフォーマット

私達は semantic-release を利用しているので、 コミットメッセージは <type>(<scope>): <subject> のフォーマットでなければいけません。

キーワード 説明
Type feat (機能), fix (バグ修正), docs (ドキュメント), style (コードフォーマットや誤字脱字など), refactor, test (テスト追加), chore (雑多なメンテナンス作業)
Scope コミットの範囲を特定するもの。空白や関連する issue 番号、* でも構いません。
Subject コミットの説明

重要: メジャーバージョンを更新する必要のある破壊的変更の際には、BREAKING CHANGE をコミットメッセージのどこかに入れてください。

コミットメッセージの例: