This version of GitHub Enterprise will be discontinued on This version of GitHub Enterprise was discontinued on 2020-08-20. No patch releases will be made, even for critical security issues. For better performance, improved security, and new features, upgrade to the latest version of GitHub Enterprise. For help with the upgrade, contact GitHub Enterprise support.

Article version: Enterprise Server 2.18

Manually creating a single issue template for your repository

When you add a manually-created issue template to your repository, project contributors will automatically see the template's contents in the issue body.

In this article

This is the legacy workflow to create an issue template. We recommend using the upgraded multiple issue template builder to create multiple issue templates. For more information, see "About issue and pull request templates."

You can create an ISSUE_TEMPLATE/ subdirectory in any of the supported folders to contain multiple issue templates, and use the template query parameter to specify the template that will fill the issue body. For more information, see "About automation for issues and pull requests with query parameters."

You can add YAML frontmatter to each issue template to pre-fill the issue title, automatically add labels and assignees, and give the template a name and description that will be shown in the template chooser that people see when creating a new issue in your repository.

Here is example YAML front matter.

---
name: Tracking issue
about: Use this template for tracking new features.
title: "[DATE]: [FEATURE NAME]"
labels: tracking issue, needs triage
assignees: octocat
---

Note: You must put YAML-reserved characters such as : in quotes. For example, ":bug: Bug".

You can create default issue templates for your organization. For more information, see "Creating a default community health file."

Adding an issue template

  1. On GitHub Enterprise, navigate to the main page of the repository.

  2. Above the list of files, click Create new file.

    "Create new file" button

  3. In the file name field:

    • To make your issue template visible in the repository's root directory, type the name of your issue_template. For example, issue_template.md.
      New issue template name in root directory
    • To make your issue template visible in the repository's docs directory, type docs/ followed by the name of your issue_template. For example, docs/issue_template.md,
      New issue template in docs directory
    • To store your file in a hidden directory, type .github/ followed by the name of your issue_template. For example, .github/issue_template.md.
      New issue template in hidden directory
    • To create multiple issue templates and use the template query parameter to specify a template to fill the issue body, type .github/ISSUE_TEMPLATE/, then the name of your issue template. For example, .github/ISSUE_TEMPLATE/issue_template.md. You can also store multiple issue templates in an ISSUE_TEMPLATE subdirectory within the root or docs/ directories. For more information, see "About automation for issues and pull requests with query parameters."
      New multiple issue template in hidden directory
  4. In the body of the new file, add your issue template. This could include:

    • YAML frontmatter
    • Expected behavior and actual behavior
    • Steps to reproduce the problem
    • Specifications like the version of the project, operating system, or hardware
  5. At the bottom of the page, type a short, meaningful commit message that describes the change you made to the file. You can attribute the commit to more than one author in the commit message. For more information, see "Creating a commit with multiple co-authors."

    Commit message for your change

  6. Below the commit message fields, decide whether to add your commit to the current branch or to a new branch. If your current branch is the default branch, you should choose to create a new branch for your commit and then create a pull request. For more information, see "Creating a new pull request."

    Commit branch options
    Templates are available to collaborators when they are merged into the repository's default branch.

  7. Click Propose new file.

    Propose new file button

Further reading

Ask a human

Can't find what you're looking for?

Contact us