本記事が目指すこと
- dbt-coreにおけるOSS活動を始めるにあたってやるべきこと、学びになったことを紹介する
- 複数回に渡り連載する予定
注意
- 投稿時点(2023/6/9)での情報に基づくため、本記事で紹介した手順が今後も利用できる保証はありません
- なお、本記事は筆者が所属する会社と関係なく、個人の記事であることをご了承ください
背景
- 筆者は、ちゅらデータ株式会社に務める会社員であるが、就業時間中に職務としてのdbt-coreのOSS活動を始めた(OSS活動自体が初めての経験)
- CONTRIBUTING.mdには明示的に記載されてない部分があったため、それらの解決策を提示する
本編
Issueの立て方、見つけ方について簡単に紹介する。
1.dbtが提供しているコントリビューター向けのドキュメントを読む
- Expectations for OSS contributors
このドキュメントには、dbt-coreにOSS活動するにあたって理解しておくべき事柄が記述されている(CONTRIBUTING.mdの上位ドキュメントという位置づけ)。
例えば、サポート、トラブルシューティング、デバッグのサポートが必要な場合は、Issueを立てるのではなく、Disscussionを開くか、dbtコミュニティのSlackの#advice-dbt-help
で質問してください、といった想定されるケースに対する問い合わせ先や注意事項等が記述されている。
2.Issueを見つける
- 既存のバグを発見したり、追加したい機能がある場合は、関連するIssueがないか確認する
- もし関連するIssueを発見して、まだ未解決であり良い提案を持っているのであればコメントする
- 自分自身がアイデアを持っていない場合は、既存のIssueから興味のあるIssueを見つける
-
good_first_issue
というラベルがついたIssueは、初めてコントリビュートする人向けのIssue。詳細な説明があったり、解決の提案が出されていたりするのでオススメ。ただし、すでにPRが紐付けられていた場合は、新規にPRを作成することはやめた方が良い
-
3.(既存のIssueが見つからない場合)Issueを立てる
1.[New Issue]をクリックして、関連する項目を選択する
- Bug
- バグまたは問題を報告する
- Feature
- 機能の直接的な拡張を提案する
- Regression
- 新しいバージョンで観察された回帰を報告する
2.定められたテンプレートに従い問題を記述し、[Submit new issue]をクリックする
参考までに筆者が作成したIssueを紹介
なお、Issueを作成すると関連する種類のタグ(例えばBugの場合はbug
)とメンテナーによってレビューされていないことを示すタグtriage
が自動で付与される。
その後、メンテナーによってレビューされた場合は、triage
が削除されて、awaiting_response
のタグがつけられる。
それに対し、コメントを返信すると、awaiting_response
が削除されて、再びtriage
のタグがつけられる。
以上。
終わりに
ちゅらデータでは、クレイジーな仲間を募集しているでござる
データエンジニア、もしくはSE系からデータエンジニアになりたい方がいればぜひ、御仁の力量に応じたグレード(ジュニア/ミドル/シニア)にて、応募するでござる