{"id":13708013,"url":"https://github.com/microsoft/repo-templates","last_synced_at":"2025-04-05T14:07:32.007Z","repository":{"id":39002410,"uuid":"257703440","full_name":"microsoft/repo-templates","owner":"microsoft","description":"Default templates for Microsoft repos across all GitHub organizations: helping providing for collaborative communities, SECURITY.MD, Code of Conduct, and other files...","archived":false,"fork":false,"pushed_at":"2024-11-22T22:34:09.000Z","size":89,"stargazers_count":68,"open_issues_count":0,"forks_count":84,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-03-29T13:09:42.655Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/microsoft.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-04-21T20:05:45.000Z","updated_at":"2025-02-28T15:24:52.000Z","dependencies_parsed_at":"2024-01-03T00:37:47.056Z","dependency_job_id":"f97bcb37-6067-46a1-9ff5-f54f089169ac","html_url":"https://github.com/microsoft/repo-templates","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2Frepo-templates","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2Frepo-templates/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2Frepo-templates/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2Frepo-templates/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/microsoft","download_url":"https://codeload.github.com/microsoft/repo-templates/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247345853,"owners_count":20924102,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-02T22:01:53.076Z","updated_at":"2025-04-05T14:07:31.988Z","avatar_url":"https://github.com/microsoft.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# @microsoft/repo-templates\r\n\r\n\u003e Microsoft's default repo templates\r\n\r\nThe **official, default** template at Microsoft is the one called **mit**.  If you combine the\r\nfiles in the `shared/` folder with the files in `projections/mit`, you get the standard, default\r\nset of files that new GitHub repos are placed with in the company.\r\n\r\n## What is this?\r\n\r\nThese files are packaged as the default, standard recommended content for net new\r\nGitHub repos created by Microsoft teams across all official Microsoft GitHub orgs such\r\nas `microsoft`, `MicrosoftDocs`, `Azure`, etc.\r\n\r\nThis is not a GitHub repo template, however, since we have a number of different\r\norgs. Previous to 2020, this content was partially mirrored in the `microsoft.github.io` repo.\r\n\r\nWhen Microsoft teams create new repos, either through internal tooling, or on GitHub directly,\r\nthese files are applied as sane defaults and help to encourage community.\r\n\r\nPlease help build the future of Microsoft open communities by making thoughtful contributions here.\r\n\r\nThese projects should be technology-agnostic.\r\n\r\n## Microsoft template types\r\n\r\nThere are several `templates` Microsoft uses at this time, partly for historical\r\nreasons, and also because there are different legal entities - some projects are\r\ncopyright Microsoft Corporation, while others are for the .NET Foundation.\r\n\r\nThe templates today are listed below. **The official, main, primary Microsoft template is called \"mit\"**:\r\n\r\n### azure-samples\r\n\r\nSample projects intended for the legacy GitHub org `azure-samples` use this template. The `README.md` file\r\nhas a boilerplate set of headings to help people get started. The repo also has a robust `CONTRIBUTING.md` file\r\nwith guidance on issues, features, etc.\r\n\r\n### contoso\r\n\r\nContoso is the Microsoft entity used for \"fake demo companies, etc.\". The Contoso template is used by\r\nMicrosoft's open source engineering system for validating the template system, but never used by actual\r\nproduct teams.\r\n\r\n### dnfmit.docs\r\n\r\nRepos that consist primarily of documentation content that are intended for .NET Foundation projects\r\nuse this template. The template consists of a `LICENSE` covering docs, a `LICENSE-CODE` file covering\r\nany code samples, and the `README.md` file has some additional language about trademarks in a\r\nLegal Notices section.\r\n\r\n### dnfmit\r\n\r\nThe standard default template for .NET Foundation projects that Microsoft teams may be helping work on\r\nand release. Similar to the `mit` license.\r\n\r\n### issueonly\r\n\r\nAn \"issue-only\" repo is a GitHub repository that primarily is used to report bugs, issues, and other\r\nfeedback, but not host or store code.\r\n\r\n### microsoft.docs\r\n\r\nDefault template for docs-related repos that are used by the [Microsoft Learn](https://learn.microsoft.com) site.\r\n\r\n### mit\r\n\r\nThe standard, default template for Microsoft releases, placing an MIT `LICENSE` file and other\r\nbasics such as a `SECURITY.MD` file.\r\n\r\n### official-sample-dnf\r\n\r\nOfficial samples that are indexed at Microsoft Learn's [code samples](https://learn.microsoft.com/samples) and also are copyright-assigned\r\nto the .NET Foundation use this template.\r\n\r\nThe `README.md` file has a rich metadata header with required fields and information that is processed\r\nby the docs site. The template outlines some of the files that are placed.\r\n\r\nSamples created through this mechanism are also configured automatically with a GitHub webhook that\r\nconnects with a sample publishing system.\r\n\r\n### official-sample-microsoft\r\n\r\nOfficial samples that are indexed at Microsoft Learn's [code samples](https://learn.microsoft.com/samples).\r\n\r\nThe `README.md` file has a rich metadata header with required fields and information that is processed\r\nby the docs site. The template outlines some of the files that are placed.\r\n\r\nSamples created through this mechanism are also configured automatically with a GitHub webhook that\r\nconnects with a sample publishing system.\r\n\r\n### other\r\n\r\nFor some reason, we once thought that having an \"other\" template made sense. It may be a good\r\ntime to remove it.\r\n\r\n## Structure of directories\r\n\r\n### `shared` directory\r\n\r\nThe common directory contains defaults that all templates use unless overridden.\r\n\r\n### `projections` directory\r\n\r\nThese are more specific templates for projects such as Microsoft official samples or\r\n.NET Foundation projects.\r\n\r\n## Output of the union of the directories\r\n\r\n```text\r\n// psuedo-code\r\nfor (each templateName of projections) {\r\n  copy(sharedFiles, excludingAnySpecialExclusions);\r\n  copy(specificProjectionFiles);\r\n}\r\n```\r\n\r\n## Contributing\r\n\r\nThis project welcomes contributions and suggestions.\r\n\r\n### Pull request review\r\n\r\nPull requests to this repo will be reviewed, at a minimum, by the Open Source Programs Office at\r\nMicrosoft, as well as a set of Microsoft's \"Open Source Champs\", for guidance.\r\n\r\nPlease understand that these templates often need to be kept rather simple, since\r\nthey are a starting point, and if there is too much guidance, teams may not be familiar\r\nwith how to react and manage projects with too much initial content.\r\n\r\n### Contribution requirements\r\n\r\nMost contributions require you to agree to a\r\nContributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us\r\nthe rights to use your contribution. For details, visit [Contributor License Agreements](https://cla.opensource.microsoft.com).\r\n\r\nWhen you submit a pull request, a CLA bot will automatically determine whether you need to provide\r\na CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions\r\nprovided by the bot. You will only need to do this once across all repos using our CLA.\r\n\r\n## Code of Conduct\r\n\r\nThis project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).\r\nFor more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or\r\ncontact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicrosoft%2Frepo-templates","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmicrosoft%2Frepo-templates","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicrosoft%2Frepo-templates/lists"}