How create github issue templates

Github is source code management platform, where developers can upload their codes, share and collaborate with others. Besides acting as code repository you can also use it for project CI/CD, Project Management.

When using github for project management you will create issues/stories/tasks to be worked on and assign them to the respective team members. When working on long term or large projects it's ideal to follow a consistent patter when creating the issues to ensure clear communication of the expected outcome from the issue (task). Creating those issues from scratch each time is not ideal as it consumes a lot of time and can create insconsitency. That's where github isse templates comes into the picture. With github issue template you can auto populate the boiler plates with placeholder that your team will fill for their respective issues making sure the format is consistent.

Let's now look into how we can create issue templates in github. There are two ways we can create issue templates,

Setting up template in gtihub settings
Creating custom md/yml files.

We will look into both wasy here one by one.

Setting up template in gtihub settings

Go to your repository
Click on the Settings tab
Scroll down to the Features sections
Make sure Issues checkbox is check and Click on Setup Template
Click on Add template: select
Select the type of issue template
Click on Preview and edit` confirm if it matches your requirement.

If you are satiesfied with the template you can click on Propose Changes and commit. Otherwise you can also click on the edit icon to modify the template.

Creating custom md/yml files.

Create a .github/ISSUE_TEMPLATE directory
Create md or yml file as issue tempalte.

For .md template make sure you add this in the head otherwise it will not show up in the list when you create new issues.

---
name: User Story
about: Describe this issue template's purpose here.
title: ''
labels: ''
assignees: ''
---

You can refer to the below links to find list of templates other people are using
- https://unicef.github.io/inventory/dpg-indicators/8/project-management/issue-templates/
- https://github.com/devspace/awesome-github-templates