メンテナーガイド#
このドキュメントでは、 メンテナー をマージ権限を持つ貢献者として定義しています。 ここで詳しく説明する情報は、主にQiskitのリリースやその他の内部プロセスに関連しています。
ブランチの安定化ポリシー#
安定ブランチは、リリース後にマスター上で修正された、影響の大きいバグやセキュリティー問題に対応する修正の安全なソースになることを目的としています。 安定ブランチのプルリクエスト(PR) をレビューする時、与えられたパッチのリスクと安定ブランチの価値のバランスを取る必要があります。 安定ブランチへの取り込みは、限定されたクラスのみの変更が適しています。 大きな問題に対する大きくリスクの高いパッチは、あまり目立たないのエラー処理のための些細な修正同様、理にかなっているかもしれません。 変更をレビューする際には、多くの要因を検討する必要があります。
リグレッションのリスク: 最も小さな変更でも何かを壊すリスクがあり、stableブランチ上でのリグレッションは本当に避けたいです。
ユーザーに見える利益: ユーザーが本当に気が付く修正していますか？そうであれば、その重要性はどのくらいですか？
修正の自己完結度: 重要な問題を修正するだけでなく多くのコードをリファクタリングしている場合は、リスクの低い修正がどのようなものになるかを検討する価値があると考えられます。
Whether the fix is already on
main: a change must be a backport of a change already merged onto master, unless the change simply does not make sense on master.
Backporting#
When a PR tagged with stable backport potential is merged, or when a
merged PR is given that tag, the Mergify bot will
open a PR to the current stable branch. You can review and merge this PR
like normal.
文書構造#
Qiskitでドキュメントを構造化する方法は、できるだけ多くの実際のドキュメントをdocstringにプッシュすることです。 ドキュメントの大部分は変更されるコードの近くにあるため、これにより、開発中に追加や修正が簡単になります。
RSTファイルやdocstringsの設定など、効果的なAPIドキュメントの作成・記述方法については、https://qiskit.github.io/qiskit_sphinx_theme/apidocs/index.html を参照してください。