8.2 Generated Versus Handwritten Files

Go To Top

Return to Generated Artifacts

The Repository should clearly separate generated files from handwritten files. This separation protects developers from editing files that generation processes may overwrite and helps reviewers understand the origin of each Artifact.

Handwritten files include source definitions, Node implementation code, scripts, Configuration templates, tests, documentation, and other Artifacts that developers intentionally author and review.

Generated files include IDL-derived language bindings, DDS type support files, documentation, Configuration fragments, topic support files, and other outputs produced by an approved generation process.

The team should place generated files under approved generated directories, such as:

generated/generated/dds/generated/docs/generated/config/The team should not place generated files in src/ unless the selected toolchain requires it and the handbook documents the reason. If a toolchain forces generated files into a source tree, the team should isolate them in a clearly named subdirectory and document the regeneration process.

© 2026 Dido Solutions, Inc. and Jackrabbit Consulting, Inc.