From c4afe09264bfcf135706e05a68626ae48194b5ce Mon Sep 17 00:00:00 2001
From: vitali87 <eheva87@gmail.com>
Date: Sun, 30 Aug 2026 14:32:49 +0100
Subject: [PATCH] docs: describe the action's objective output as the
 simplified score

scripts/score_pr.py computes overflow*1000 + file_scatter*50 + groups,
not the full score_plan objective (underflow, edges, tiny groups,
depth/width) that README and METHODOLOGY describe; say so.
---
 README.md  | 2 +-
 action.yml | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 01a0b24..c3f9e47 100644
--- a/README.md
+++ b/README.md
@@ -244,7 +244,7 @@ jobs:
 |--------|-------------|
 | `total-loc` | Total lines of code in the PR diff |
 | `total-groups` | Number of suggested groups |
-| `objective` | Plan objective score (lower is better) |
+| `objective` | Simplified plan score, `overflow × 1000 + file_scatter × 50 + groups` (lower is better; not the full `score_plan` objective described in METHODOLOGY.md) |
 | `should-split` | Whether the PR should be split (`true`/`false`) |
 
 ## Planning backends
diff --git a/action.yml b/action.yml
index dc53a20..ae7693c 100644
--- a/action.yml
+++ b/action.yml
@@ -35,7 +35,7 @@ outputs:
     description: "Number of suggested groups"
     value: ${{ steps.score.outputs.total_groups }}
   objective:
-    description: "Plan objective score (lower is better)"
+    description: "Simplified plan score: overflow*1000 + file_scatter*50 + groups (lower is better)"
     value: ${{ steps.score.outputs.objective }}
   should-split:
     description: "Whether the PR should be split (true/false)"