最近はDjangoに新しいバージョンが出ると、その対応ができていることを示すプルリクエストを作成しています。高速なPythonパッケージマネージャであるuvを使うことで、このプロセスがとても簡単になりました。
2024年の例として、django-storages に Django 5.1 対応のプルリクエストを出すときに行った手順を紹介します。 https://github.com/jschneier/django-storages/pull/1444
やったこと
- リポジトリをforkする
uv venvを実行して仮想環境を作成(従来の方法より高速で依存関係の解決も正確です)- 仮想環境に入る
- django-storagesはtoxを使っている。手元にtoxがないので
pip install toxを実行する - Django 5.1をtoxのリストに追加するコミットを作る コミット内容
- プルリクエストを作成する プルリクエスト
- 失敗したこと: CHANGELOGファイルに記載するのを忘れてしまってました。別のプルリクエストを作りましたが、作者の方がご自身で対応してくれました。
Python歴が短い自分にとって、uvの高速な環境構築と依存関係の解決は大きな助けになっています。特に uv venv コマンド一つで清潔な環境が素早く作れるので、気軽にオープンソースへの貢献ができます。
Django自体の変化が少ないため、こうした対応をしなくても動くことが多い(実際django-storagesへのプルリクエストではパッケージ内のコードは変えていない)です。 ただ、明示的に対応バージョンを記載しておくことでユーザーにとってはメリットが大きいのかなと思っています。
注意点
こうした貢献は簡単ですが、同時に安易にプルリクエストを乱発することはパッケージのメンテナに負担をかけることになるので、以下のポイントを考慮するようにしています。
- 本当に必要な変更か確認する(すでに誰かが同様のPRを作成していないか)
- テストが通ることを確認してからPRを出す
- ドキュメントの更新が必要な場合は一緒に行う
- 前述の通りCHANGELOGの変更を忘れていました。反省。
- メンテナが理解しやすいように変更内容を明確に説明する
- 今回の例にあるプルリクエストにも説明がありませんでした。こちらも反省。
メンテナの時間と労力を尊重する姿勢も大切にしつつ、貢献していきたいです。