+9 -6
View File
@@ -13,14 +13,17 @@
- Never commit autogenerated code to the repository. This applies to backend, - Never commit autogenerated code to the repository. This applies to backend,
frontend, shared packages, and every other module, including generated frontend, shared packages, and every other module, including generated
protobuf bindings, API clients, serializers, and framework-generated code. protobuf bindings, API clients, serializers, and framework-generated code.
- Commit the source definitions, generator configuration, and reproducible - Use externally published schemas as generation inputs. Do not embed or commit
generation commands instead. Generate code locally or during build and CI schema snapshots in the repository. Commit external schema references,
workflows before any dependent validation or compilation steps. generator configuration, and reproducible generation commands instead.
- Fetch the externally published schemas and generate code at build time, before
any dependent validation or compilation steps, including in CI.
- Keep generated outputs ignored by Git. Do not force-add ignored generated - Keep generated outputs ignored by Git. Do not force-add ignored generated
files or copy generated code into tracked source files. files or copy generated code into tracked source files.
- Change the source definitions or generator inputs rather than editing - Change schema sources in their owning project or update external schema
generated outputs. Document the generation workflow so a clean checkout can references and generator inputs rather than editing generated outputs.
build without committed generated code. Document the generation workflow so a clean checkout can build without
committed generated code or embedded schema snapshots.
## Local development tooling ## Local development tooling