Files
crank/docs/development-evidence.md
T

4.8 KiB
Raw Blame History

Evidence разработки

Этот порядок помогает восстановить состояние кода и результат каждого проверяемого этапа. Он не заменяет Capability Baseline: baseline хранит версионированный снимок capability Inventory и исторические результаты, а completion evidence указывает, что именно проверено для текущего этапа или завершения.

Ревизии этапа

До начала этапа запишите полный Git commit baseline_commit и убедитесь, что git status --short пуст. Это проверка tracked, staged и обычных untracked изменений; игнорируемые локальные файлы не входят в Git baseline. Не записывайте baseline + uncommitted worktree как revision.

После изменений сохраните проверенный implementation revision отдельным полным commit hash. Проверки, которые подтверждают завершение этапа, должны относиться к этому commit при чистом worktree. Укажите использованные конфигурацию и класс окружения: одинаковый commit сам по себе не описывает их.

Если нужен RED до коммита, зафиксируйте его как промежуточное наблюдение: укажите baseline_commit, SHA-256 сохранённого diff/artifact, включающего изменения (в том числе untracked test files), команду и её фактический результат. Не представляйте baseline вместе с незакоммиченным diff как implementation revision. После RED повторите нужные проверки на отдельном чистом implementation revision.

Запись completion evidence

Для текущего завершения используйте отдельный versioned index и sanitized evidence-файлы с устойчивыми repository-relative ссылками. Запись должна позволять повторно определить проверенное состояние и результат, не сохраняя секреты, локальные абсолютные пути или произвольные payloads. Для каждой проверки укажите:

  • идентификатор этапа/запуска и полный baseline_commit;
  • полный implementation_revision проверенного commit;
  • конфигурацию/toolchain и класс окружения;
  • точную команду, exit code и фактические counts passed, failed, skipped (или эквивалентный summary для команды без тестового счётчика);
  • repository-relative путь к sanitised log/report и его SHA-256.

Если результаты не относятся к одной и той же ревизии, конфигурации или окружению, записывайте их раздельно. Не выводите PASS из exit code без проверки счётчиков и пропусков; сохраняйте fail, flaky, skipped, not-run и manual-only как наблюдались. Новое completion evidence не переписывает historical baseline или его manual failures.

Изменение canonical Capability Inventory status/evidence по-прежнему требует обновить versioned docs/capability-baseline/manifest.json, sanitized docs/capability-baseline/results.json, baseline_version и SHA-256 согласно его schema и проверкам. Отдельный completion index не ослабляет и не обходит этот gate.

Компактный шаблон записи:

id: <stage-or-run-id>
baseline_commit: <full-git-commit>
implementation_revision: <full-git-commit>
environment:
  class: <environment-class>
  config: <tracked-config-or-versioned-reference>
command: <exact-command>
exit_code: <actual-integer>
counts:
  passed: <actual-count>
  failed: <actual-count>
  skipped: <actual-count>
evidence:
  path: <repository-relative-sanitized-report>
  sha256: <sha256-of-report>

Для промежуточного RED вместо implementation_revision укажите diff_sha256 и ссылку на сохранённый diff/artifact; не выдавайте его за проверенный implementation commit.