| |
| fxdemo:05-part:04-repository-layout:04-1-repository-design-principles:start [2026/08/08 19:22] – created owen | fxdemo:05-part:04-repository-layout:04-1-repository-design-principles:start [2026/08/08 19:22] (current) – owen |
|---|
| The Repository layout should support the following principles: | The Repository layout should support the following principles: |
| |
| * Separate handwritten source files from generated Artifacts. | - Separate handwritten source files from generated Artifacts. |
| * Separate architecture-facing documentation from developer-facing documentation. | - Separate architecture-facing documentation from developer-facing documentation. |
| * Separate source definitions from build outputs and runtime outputs. | - Separate source definitions from build outputs and runtime outputs. |
| * Separate reusable implementation code from demonstration-specific [[dido:99_annexes:annex-b-terms-and-definitions:c:configuration|Configuration]]. | - Separate reusable implementation code from demonstration-specific [[dido:99_annexes:annex-b-terms-and-definitions:c:configuration|Configuration]]. |
| * Keep scripts, Configuration files, [[dido:99_annexes:annex-b-terms-and-definitions:i:idl|IDL]] definitions, tests, and documentation in predictable locations. | - Keep scripts, Configuration files, [[dido:99_annexes:annex-b-terms-and-definitions:i:idl|IDL]] definitions, tests, and documentation in predictable locations. |
| * Ensure that every top-level directory has a clear purpose. | - Ensure that every top-level directory has a clear purpose. |
| * Avoid hidden [[dido:99_annexes:annex-b-terms-and-definitions:d:dependency|Dependencies]] on local machine paths, shell profiles, IDE settings, or personal tooling. | - Avoid hidden [[dido:99_annexes:annex-b-terms-and-definitions:d:dependency|Dependencies]] on local machine paths, shell profiles, IDE settings, or personal tooling. |
| |
| The Repository should help the team answer basic questions quickly: where does the source code live, where do IDL definitions live, where does the generated code go, where do scripts live, where does the Configuration live, where do logs go, and which Artifacts should [[dido:99_annexes:annex-b-terms-and-definitions:g:git|Git]] track? | The Repository should help the team answer basic questions quickly: where does the source code live, where do IDL definitions live, where does the generated code go, where do scripts live, where does the Configuration live, where do logs go, and which Artifacts should [[dido:99_annexes:annex-b-terms-and-definitions:g:git|Git]] track? |