NuGet Template Repository

This is a template repo that contains the default configuration for building and publishing a single NuGet package.

---
title: Personal GitHub Repo Structure
---

flowchart TB

  subgraph subGH [" "]
    gh(**.github**
    repo)

    noteGH[This contains core files
    to be referenced by
    or synced to other repos.]
  end

  subgraph subT [" "]
    T1(**.template-<type>**
    repo)

    T2(**.template-<type>**
    repo)

    noteT[These define more specific
    default files and structures
    for different repo types.]
  end

  subgraph subR [" "]
    R1(**<name>**
    repo)

    R2(**<name>**
    repo)

    R3(**<name>**
    repo)

    R4(**<name>**
    repo)

    noteR[These are the actual repos
    where projects live.]
  end

  classDef current fill:#E68A39,color:#000000
  class T1,T2 current

  classDef sub opacity:0
  class subGH,subT,subR sub

  classDef note fill:#FFFFDD,color:#000000
  class noteGH,noteT,noteR note

  gh --> T1
  gh --> T2

  T1 --> R1
  T1 --> R2
  T2 --> R3
  T2 --> R4

Loading

Table of Contents

• Description of Files in This Template Repo
  • Community Health
  • GitHub Configuration
  • GitHub Workflows
  • .NET Configuration
  • .NET Placeholder Solution
  • Build Scripts
  • Other Files

Description of Files in This Template Repo

GitHub allows some community health and GitHub configuration files to only reside in the .github repo and automatically appear in all other repos. However, we can't take full advantage of that feature because most files need repo-specific customization.

Community Health

File	Exists only in .github repo	Overridden in template repo	Notes
📁.github/
├─📄CODEOWNERS	N/A	✅
└─📄FUNDING.yml	✅
📄CODE_OF_CONDUCT.md		✅	Linked to by other files
📄CONTRIBUTING.md		✅	Links to other files
📄GOVERNANCE.md	—	—	Not implemented
📄LICENSE	N/A	✅
📄SECURITY.md		✅	Links to GitHub repo
📄SUPPORT.md		✅	Links to other files

GitHub Configuration

Template	Exists only in .github repo	Overridden in template repo	Description
📁.github/
├─📁DISCUSSION_TEMPLATE/	—	—	Not implemented
├─📁ISSUE_TEMPLATE/		✅	Contains GitHub Issue forms
│    └─📄config.yml	✅		GitHub Issue template chooser
├─📄codecov.yml	N/A	✅	Codecov configuration
├─📄copilot-instructions.md	N/A	✅	Copilot configuration
├─📄dependabot.yml	N/A	✅	Dependabot configuration
├─📄pull_request_template.md		✅	GitHub Pull Request template
└─📄settings.yml	N/A	✅	Repo configuration

GitHub Workflows

Workflow	Description
📁.github/
└─📁workflows/
├─📄Continuous Integration	Builds, tests, and packs the solution.
├─📄Create Release	Creates draft Releases in GitHub
├─📄Publish Packages	Publishes packages to GitHub Packages and NuGet.org
├─📄Template Sync	Synchronizes files from a template repo to a derived repo
└─📄Validate Codecov	Validates changes to codecov.yml

.NET Configuration

File	Description
📁.config/	Contains dotnet tool settings
📄.vsconfig	Visual Studio settings
📄global.json	.NET SDK settings
📄nuget.config	NuGet settings
📄StyleCop.json	StyleCop (code analysis) settings

.NET Placeholder Solution

File	Description
📁src/	Contains production code
└─📄Production.props	.NET project properties for production code
📁test/	Contains test code
├─📄.editorconfig	Code analysis exceptions for test code
├─📄Test.props	.NET project properties for test code
└─📄Test.runsettings	.NET test run settings
📄Common.props	.NET project properties for all code
📄Icon.png	NuGet package icon
📄Icon.svg	NuGet package icon source
📄Placeholder.sln	Visual Studio solution

Build Scripts

File	Description
📄Build.ps1	Full build script (PowerShell)
📄build.sh	Full build script (bash)
📄Test.ps1	Full build & test script (PowerShell)
📄Test.sh	Full build & test script (bash)

Other Files

File	Description
📁.vscode/	Contains VSCode settings
📁docs/	Contains documentation
📁test/	Contains test code
└─📄TestHelpers.psm1	Helper methods for Continuous Integration
📄_checklist.md	New template repo checklist
📄.editorconfig	Styleguide rule definitions
📄.gitattributes	Built using scaffolding
📄.gitignore	Built using scaffolding
📄.gitmessage	Commit message template
📄GenerateChangelog.ps1	Script for generating the release changelog
📄GitVersion.yml	GitVersion configuration