Template

This repository serves as a Default Template Repository according official GitHub Contributing Guidelines for healthy contributions. It brings you clean default Templates for several areas:

• Azure DevOps Pull Requests (.azuredevops\PULL_REQUEST_TEMPLATE.md)
• Azure Pipelines (.pipelines/pipeline.yml)
• GitHub Workflows
  • Super Linter (.github/workflows/linter.yml)
  • PowerShell ScriptAnalyzer (.github/workflows/scriptanalyzer.yml)
  • Template Sync (.github/workflows/template-sync.yml) keeps generated repos in sync with this template
  • Sample Workflows (.github/workflows/workflow.yml)
• PowerShell scaffolding (PowerShell/_Template.ps1, PowerShell/Write-Log.psm1)
• Bash scaffolding (Bash/_Template.sh, Bash/log.sh)
• PSScriptAnalyzer settings (PSScriptAnalyzerSettings.psd1)
• GitHub Pull Requests (.github/PULL_REQUEST_TEMPLATE.md)
• GitHub Issues
  • Feature Requests (.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md)
  • Bug Reports (.github/ISSUE_TEMPLATE/BUG_REPORT.md)
• Codeowners (.github/CODEOWNERS) adjust usernames once cloned
• Wiki and Documentation (docs/)
• gitignore (.gitignore)
• gitattributes (.gitattributes)
• Changelog (CHANGELOG.md)
• Code of Conduct (CODE_OF_CONDUCT.md)
• Contribution (CONTRIBUTING.md)
• License (LICENSE) adjust projectname once cloned
• Readme (README.md)
• Security (SECURITY.md)

Status

Creating a repository from a template

You can generate a new repository with the same directory structure and files as an existing repository. More details can be found here.

After generating a repository

A generated repository keeps the template's placeholders. Replace them before you start, or you ship the template's identity instead of your own:

• README.md - rewrite the title, description and badge URLs (segraef/Template -> <owner>/<repo>).
• README.md / CONTRIBUTING.md - update the [GitHubIssues] link to your repo.
• CHANGELOG.md - replace the @your_username / example entries with real ones.
• CODE_OF_CONDUCT.md - fill in the [INSERT EMAIL ADDRESS] contact.
• LICENSE - confirm the copyright holder and year.
• .github/CODEOWNERS - set the owning user/team.
• SECURITY.md - point reporting at a channel you actually monitor.

Keeping in sync with this template

GitHub's "Use this template" copies files once with no ongoing link (the generated repo has an unrelated git history). To pull later template changes:

• Automatic: the included template-sync.yml workflow (AndreasAugustin/actions-template-sync) opens a PR whenever this template changes. Protect repo-specific files with .templatesyncignore.

• Manual: add this template as a remote and cherry-pick scaffolding changes:

  git remote add template https://github.com/segraef/Template.git
  git fetch template
  git checkout template/main -- .github .gitignore .gitattributes PSScriptAnalyzerSettings.psd1

Reporting Issues and Feedback

Issues and Bugs

If you find any bugs, please file an issue in the GitHub Issues page. Please fill out the provided template with the appropriate information.

If you are taking the time to mention a problem, even a seemingly minor one, it is greatly appreciated, and a totally valid contribution to this project. Thank you!

Feedback

If there is a feature you would like to see in here, please file an issue or feature request in the GitHub Issues page to provide direct feedback.

Contribution

If you would like to become an active contributor to this repository or project, please follow the instructions provided in CONTRIBUTING.md.

Learn More

• GitHub Documentation
• Azure DevOps Documentation
• Microsoft Azure Documentation