4.9 Git-Controlled and Non-Git-Controlled Content

Go To Top

Return to Repository Layout

The Repository should clearly distinguish between Artifacts that Git tracks and those it ignores. This distinction protects Reproducibility and prevents local machine outputs from polluting the shared Baseline.

Git should normally track:

1. Handwritten source files.
2. IDL source definitions.
3. Configuration templates and Baseline Configuration files.
4. Build and run scripts.
5. Container definitions.
6. Tests.
7. Documentation.
8. Controlled-generated Artifacts, if the team explicitly decides to Version them.

Git should normally ignore:

1. Local virtual environments.
2. Machine-specific environment files.
3. Build outputs.
4. Temporary generated files.
5. Runtime logs.
6. Container runtime Artifacts.
7. Local IDE cache files.
8. Developer-specific override files.

The .gitignore file should document these decisions through clear patterns and comments. If the team decides to Version a generated Artifact, the Repository should explain why that Artifact belongs in Git and how developers should regenerate or verify it.

The Repository layout should make Git review easier. Reviewers should be able to identify whether a change affects architecture-facing definitions, handwritten implementation code, generated outputs, Configuration, scripts, tests, documentation, containers, or runtime Evidence.