修正案のレビューと反映

コードが変わると、修正案が先に届きます。Specifyはpushされた変更を読み取り、影響を受けるドキュメントを見つけて、レビューする修正案を用意します。反映はチームが定めたポリシーに従います。

修正案が用意されるまで#

1. ドキュメントプロジェクトのソースブランチにコードが反映されます。そのソースでpush で実行がオンになっている必要があります。
2. Specifyが変更内容とプロジェクトが管理するドキュメントを照らし合わせ、影響を受けるドキュメントを見つけます。
3. ドキュメントごとに、変更の根拠と修正前後を含む修正案を用意します。

修正案に含まれるもの#

レビューして反映する#

修正案の根拠と修正前後を確認して承認すると、ドキュメントに反映されます。人がレビューして承認した変更だけが反映されるのが基本の流れです。

よいレビューのためのチェックリスト#

• 根拠として示されたコード変更が、実際にドキュメントの内容と関係しているか
• 削除された項目や名前が変わった項目が、ドキュメント全体で一貫して反映されているか
• サンプルコードやリクエスト・レスポンスの例が、新しい動作と一致しているか
• 人が判断すべき説明（設計意図、運用ポリシー）が、自動修正で上書きされていないか

プロジェクトの状態#

プロジェクト一覧の状態バッジで、レビューが必要なプロジェクトを見つけられます。