Solution and Project Structure

ADR ID

adr-003

Status

accepted

Scope

global

Deciders

github group

Date

7/8/2021

Context

When it comes to creating and maintaining projects, multiple parallel approaches are known, like monorepo, individual repos, submodules, etc. And same way, when it comes to maintaining the actual source code, multiple different approaches do exist, depending on each particular language or technology and its capabilities or best practices.

Decision

• We would avoid the use of submodules
• If needed, we would employ multiple individual repos instead
• We would provide editor configuration files for both Visual Studio Code and Visual Studio .NET
• We would depend on Directory.Build.targets/props and folder structures instead of custom csproj customizations
• We would depend on using an eng/Dependencies.props file instead of having the versions of Nuget files repeatedly entered into the csproj files
• We would use automated tooling to achieve the maintenance of Dependencies.props file

Consequences

• We would need to implement an automated tooling for csproj maintenance
• We would need to add that tooling as part of a build check (e.g. run that tool in dry run and break if it would have done any changes)