Issues¶
Creating an Issue¶
Before you start initiating changes to a repository, it's important what you're working on is trackable and visible to other developers. Such a way to do this is using GitHub Issues, which allows you to describe the problem you're trying to tackle. This is a tab available on each GitHub repository's web page. Navigating there also allows you to see already open or closed issues, so that you don't end up working on something that someone else has already started.
On the right side, use these sections to assign the task to yourself, apply the relevant labels, and link to a project - such as the current sprint. If an issue already exists, then just simply assign the issue to yourself.
Creating an Issue Template¶
- Within the repository that you wish to create an issue template for, click on the Settings tab.
- Scroll down to the Features section, under Issues click the green "Set up templates" button.
- Select the kind of issue template you wish to create. GitHub provides editable standard templates for Bug reports and Feature requests, or for a blank slate select Custom template.
- Once satisfied with the templates, click the green "Propose changes" button. This will cause the Commit changes bar to appear, allowing an extended description of the changes made. Finally, press the "Commit changes" button, this creates a two directories:
.github
and within thatISSUE_TEMPLATE
.