1# Golden Generated Files
2
3This directory is a repository for the generated files of `flatc`.
4
5We check in the generated code so we can see, during a PR review, how the
6changes affect the generated output. Its also useful as a reference to point too
7as how things work across various languages.
8
9These files are **NOT** intended to be depended on by any code, such as tests or
10or compiled examples.
11
12## Languages Specifics
13
14Each language should keep their generated code in their respective directories.
15However, the parent schemas can, and should, be shared so we have a consistent
16view of things across languages. These are kept in the `schema/` directory.
17
18Some languages may not support every generation feature, so each language is
19required to specify the `flatc` arguments individually.
20
21* Try to avoid includes and nested directories, preferring it as flat as
22possible.
23
24## Updating
25
26Just run the `generate_goldens.py` script and it should generate them all.
View as plain text