Skip to main content

Creating discussion category forms

You can customize the templates that are available for community members to use when they open new discussions in your repository.

Note: Discussion category forms are currently in limited public beta and subject to change.

About discussion category forms

You can encourage community members to include specific, structured information in their discussions by using discussion forms in your repository. With discussion category forms, you can create discussion templates that have customizable web form fields. Discussion forms are written in YAML using the GitHub form schema. For more information, see "Syntax for GitHub's form schema."

If you're new to YAML and want to learn more, see "Learn YAML in Y minutes."

To use a discussion category form in your repository, you must create a new file and add it to the /.github/DISCUSSION_TEMPLATE/ folder in your repository.

You can also create discussion category forms for your organization. For more information, see "Creating a default community health file."

Discussion category forms are not supported for polls. For more information about polls, see "About polls."

Here is the rendered version of the issue form.

Screenshot of a rendered discussion category form

Creating discussion category forms

People with write access to a repository can create a discussion category form.

  1. Navigate to the repository where you want to create a discussion category form.
  2. In your repository, create a file called /.github/DISCUSSION_TEMPLATE/FORM-NAME.yml, replacing FORM-NAME with the name for your discussion category form. The name must correspond with the slug for one of your discussion categories. For example, the template for the "Announcements" category should be .github/DISCUSSION_TEMPLATE/announcements.yml. For more information about creating new files on GitHub, see "Creating new files."
  3. In the body of the new file, type the contents of your discussion category form. For more information, see "Syntax for discussion category forms."
  4. Commit your file to the default branch of your repository. For more information, see "Creating new files."