Skip to content

Creating an Issue Template

SophAm1 edited this page Apr 15, 2023 · 2 revisions

Review Guidelines

  1. Look over appropriate issue formatting to get an understanding of what a good issue looks step-by-step
  2. Make sure the new issue template you are creating encompasses the set standard
  3. Create your first issue template using the directions below

Creating an Issue Template

To create an issue template on GitHub, follow these steps:

  1. Open the repository: Navigate to the repository where you want to create the issue template.
  2. Go to the "Issues" tab: Click on the "Issues" tab at the top of the repository.
  3. Click on "New issue": Click on the green "New issue" button on the right-hand side of the page.
  4. Create a new template: Click on the "Get started" button next to "Create a new issue template" or click on the "New issue template" button on the left-hand side of the page.
  5. Create your template: Use the markdown syntax to create your issue template. Include any necessary sections and fields that you want to appear in every issue.
  6. Preview your template: Click on the "Preview" tab to preview your template and make any necessary adjustments. Save your template: When you are satisfied with your template, click on the "Commit new file" button at the bottom of the page to save your template.
  7. Use your template: Now, whenever someone creates a new issue in your repository, they will have the option to use your template by clicking on the "Use this template" button and filling out the necessary fields.
  8. By creating an issue template, you can ensure that all issues created in your repository follow a consistent format and include all the necessary information. This can help improve communication and collaboration within your team.

Clone this wiki locally