Sometimes we store generated files in source folders. For example, Java sources generated with Protocol Buffers can be committed to the repository for convenience. Another example is
yarn.lock files which contain resolved versions of dependencies.
There is a variety of tools which work with files:
These tools need to handle generated files differently, for example:
Let's invent a standard how to mark files generated.
We did not find any common conventions, so we picked
marker. Place it anywhere in the beginning of the file, and the file is considered generated:
# This file is @generated by ./gen.sh.
# Do not edit.
@generated marker internally
@generated as well
Cargo.lock files with
@generated tag (which is accidentally compatible with
Or have something else to say? Send us a message to email@example.com.