Closed TessFerrandez closed 2 years ago
Look at https://help.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-template-repository for potential other templates...
This isssue is just a starting point, we can add other issues later for specific templates
This is a good idea. I see drift from one project to the next and it would be nice if we offered guidance for at least the common root-level folder structure Then, teams can decide how they want to structure sub-folders or add additional root-level folders if needed. There's some common patterns that we could adopt that align to other repos, such as the .NET Runtime, Roslyn, AKS, and of course the one you suggested above. Taking ideas from these repos, perhaps we suggest something like this to start with:
├── README.md // Obvious
├── docs/ // More docs that the reader can link into from README.md
├── eng/ // Engineering assets such as CI/CD pipelines, scripts, etc.
├── pipelines/
├── common/
├── src/ // Source code
├── infra/ // Infrastructure-as-code, such as ARM or Terraform Templates, configuration scripts, etc.
Closing due to lack of activity
As an example, for data science and python you can use https://drivendata.github.io/cookiecutter-data-science/#example as a project template to automatically incorporate a lot of best practices.
For DDD .NET MicroServices - https://docs.microsoft.com/en-us/dotnet/architecture/microservices/microservice-ddd-cqrs-patterns/ddd-oriented-microservice
Terraform?