For the complete documentation index, see llms.txt. This page is also available as Markdown.

Repository Layout

Purpose

Repository layout must make build, test, review and release predictable.

Standard Layout

repo-root/
  .editorconfig
  .gitignore
  global.json
  Directory.Build.props
  Directory.Packages.props
  nuget.config
  README.md
  SECURITY.md
  CHANGELOG.md
  docs/
  eng/
  src/
  tests/
  tools/

Required Files

File
Purpose

README.md

Setup, build, test and run instructions

global.json

SDK pinning

.editorconfig

Formatting and analyzer configuration

Directory.Build.props

Shared build properties

Directory.Packages.props

Central NuGet versions

nuget.config

Approved package feeds

SECURITY.md

Security reporting and handling route

CHANGELOG.md

Release history

Documentation Folders

Repository Rules

  • Main branch is protected.

  • All changes are pull-request based unless emergency process applies.

  • Build and tests must pass before merge.

  • Generated artifacts must not be committed unless approved.

  • Secrets must not be committed.

  • Large binaries must be avoided or stored through approved artifact storage.

  • Ownership must be clear through CODEOWNERS or equivalent.

Last updated

Was this helpful?