====== 10 Repo Structure ======

//Our projects are hosted on the [[https://code.hampel-soft.com/|HSE GitLab Server]].// 

This page defines the default repository structure used by these projects. 

<WRAP left round info 100%>
Repository names are always **lower-case**!
</WRAP>



	/Documentation
	    /DocGen                        // RAT-generated documentation
	    requirements.xlsx              // requirements document
	/PPL                               // PPLs the project code depends on
	/Resources                         // Various stuff, like icons
	/<%project_directory%>             // Contains the actual source codes of the project
	/Tests                             // All sorts of tests for the repo
	    /Unit Tests                    // Unit Tests for the source code
	/Tools                             // Project-related helpers like converters etc
	    /PPL                           // Tools related to using and building PPLs
	    /VIP                           // Tools related to building VI packages 
	.gitignore                         // ignore definitions for git
	.gitlab-ci.yml                     // generic config for gitlab CI
	CONTRIBUTING.md                    // details about collaborating
	rat.yml                            // specific config for gitlab CI
	rat-analyzr.cfg                    // config file for VI Analyzer (LV version specific!)
	LICENSE                            // legal details
	README.md                          // description of project
	<%project_name%>.vipc              // VIPM configuration file
	<%project_name%>.vipb              // VIP build configuration file (if applicable)

<WRAP left round tip 100%>
For details on the //project directory// structure, see the **[[code:common:project-structure|Project Structure]]** wiki page.
</WRAP>

More information on the files displayed here are available:

  * [[processes:version-control|.gitignore]]
  * [[code:commercial:rat|.gitlab-ci.yml and rat.yml]]
  * [[code:common:readme|README.md]]
  * [[code:common:license|LICENSE]]
  * [[code:common:contributing|CONTRIBUTING.md]]

---- 


<WRAP left round info 80%>
For a more generic take on how we structure our software projects, see the **[[kb:bestpractices:wow:structure|Structure]]** page of our [[kb:bestpractices:wow|WoW description]].
</WRAP>