chore: add instructions for updating golden files (#728)

* chore: add instructions for updating golden files
googleapis · Jan 17, 2025 · b0640dc · b0640dc
1 parent d9a10e4
commit b0640dc
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/doc/contributor/howto-guide-generated-code-maintenance.md b/doc/contributor/howto-guide-generated-code-maintenance.md
@@ -66,6 +66,19 @@ go -C generator/ run ./cmd/sidekick refreshall -project-root .. && cargo fmt
 
 Then run the unit tests and send a PR with whatever changed.
 
+## Update golden files
+
+The golden files live under `generator/testdata`.
+
+Run:
+
+```bash
+go -C generator test ./...
+```
+
+After updating the golden files, make sure to run `git diff generator/testdata`
+to verify the changes before committing them.
+
 ## The Glorious Future
 
 Someday `sidekick` will be stable enough that (a) it will not be part of the