背景
ragas での Timeout を調査した際に、log の内容で、エラーっぽいものが表示されていた。
json_string = json_bytes.decode("utf-8")
^^^^^^^^^^^^^^^^^^^^^^^^^^
UnicodeDecodeError: 'utf-8' codec can't decode bytes in position 496-497: invalid continuation byte
Timeout が消えても残っているのが気になって調べたところ対処できたので、以前は断念した Contribute でもしてみるかと思い立った記録
対象 source は 以下
結論
とりあえず、Pull Request して、test も問題なく通った。
あとは、Review されて、通るかどうか。
反応があるまであとは待つだけかな。
概要
- Contributiing Guide の確認
- Fork して、修正
- Pull Request すると以下が自動で進む
- あとは、Review を待つ・・不安な時間を過ごす ...
詳細
事前準備としての contributing guide の確認
CLA を読んでおく。
初めての contribution の場合には、CLA に署名するって程度の理解
Contributing Guide
自動生成コードについて
Code generated by Microsoft (R) AutoRest Code Generator. って書いてあるものは、自動生成コードなんで通常のマージと違うよって感じ詳細は https://github.com/Azure/azure-rest-api-specs/ へ（未読）
ツールについて
以下のようなものがあるんで、理解してね
-
Tox
- テスト環境管理
-
Virtualenv
- Tox で利用する仮想環境
-
pytest
- 単体テスト
-
pylint
- linting
-
Mypy & Pyright
- 型チェック（型解釈と完全性検証）
-
Sphinx
- ドキュメント生成
-
Bandit
- セキュリティ問題の調査？
-
Azure DevOps
- CI/CD
ビルドとテスト
- Tox の説明
- Tox の使用例
とか、Tox について色々書いてある。とりあえず必要になったときに見返す感じかな
サンプル
- サンプルでは 3rd party library は使わないようにしようって程度の理解
サンプル作成する機会があったら考えよう
行動規範
以下にある。
要約すると
誓約: すべての貢献者とメンテナーは、ハラスメントのない環境を提供することを誓います。
基準: 包括的な言葉を使用し、異なる視点を尊重し、建設的な批判を受け入れることが推奨されます。不適切な行動には、性的な言葉や画像の使用、トローリング、ハラスメントなどが含まれます。
責任: プロジェクトメンテナーは、許容される行動の基準を明確にし、違反行動に対して適切な措置を講じる責任があります。
適用範囲: この行動規範は、プロジェクトスペース内およびプロジェクトやコミュニティを代表する個人が公的な場で行動する場合に適用されます。
執行: 不適切な行動はプロジェクトチームに報告され、調査と適切な対応が行われます。
実際にやったこと
前提
library での問題を、利用環境で修正して動作確認
準備
- main ブランチの Fork
- 事前の修正を反映
- Commit
- Pull Request 作成
- 初めてだよね？ってことで
- CONTRIBUTING.md を確認してね。事前に見ているので・・多分大丈夫？
- で、test を local でって話だが・・後述の理由でパス
- 初めてだよね？ってことで
- PR 後は、自動で test などが進んで、いつの間にかCLAも終わってた。で、以下は Review 待ちの状態
local test をパスした理由
-
eng_sys_checks.md だったり、azure-sdk-tools/README.md をみても、tox 環境を作って
azure identityの test をする方法がよくわからない。 - 他の PR を見てみたら、幾つかある checklist が空っぽの人もいる
- import 時に動作確認をしている
- 変更点は、log 用のところで、そもそも test がない？
search results - やってみて、怒られてみようという気になった
誰でも最初は失敗する筈・・と
あとがき
初めての事って勇気がいりますよね。
とはいえ、人生初の Contributor としての第一歩を踏み出せたのはよかったと思おう 