diff --git a/docs/recommended-harness.md b/docs/recommended-harness.md index 1ec442dde..f4521dc57 100644 --- a/docs/recommended-harness.md +++ b/docs/recommended-harness.md @@ -257,7 +257,7 @@ line whose input could not be read says `unavailable ()` rather than 0. gstack-factory-scorecard --repo owner/name --since-days 7 \ [--crew login,login] [--gate-workflow evals.yml] [--free-workflow free-tests.yml] \ [--train-prefix train/] [--ready-marker 'READY #\d+|SHIP_RECEIPT:'] [--pass-marker '"passes": (\d+)|passes=(\d+)'] \ - [--pass-cap 3] [--out-dir .context/factory-scorecard] + [--pass-cap 3] [--out-dir .context/factory-scorecard] [--now ] ``` `--repo` defaults to the origin remote's owner/name on github.com (or @@ -265,6 +265,10 @@ gstack-factory-scorecard --repo owner/name --since-days 7 \ to `--out-dir` and appends the same rows to `trend.csv` there, so a weekly retro accumulates its own trend without renaming files. +The window is `[now - since-days, now)`: `--now` (default: the current time) +sets its end, and every line counts only items inside it, so a past week +measured later does not count anything that happened after that week. + | Line | How it is counted | What one of the best software factories would show | |---|---|---| | Merged PRs | `merged_at` in the window, base = default branch; crew by `--crew` logins, else author association OWNER/MEMBER/COLLABORATOR | several merges a day, every day; outside contributions land in the same week |