If you are unfamiliar with GitHub issues then please review the official documentation on them.
There are 3 category of issues that should be added to this repository:
Use this to report on any issue in the application or the repository. For this you should use the Bug Report template. Here are the steps:
- Click on the create new issue button.
- You will be given an option to select a template.
- Select the Bug Report tempalate.
- Start writing the issues based on the template.
Features are new additions to the application. Typically all the feature issues should be created before the beginning of the project. However, new feature issues could be created at the beginning of a new sprint as well. For this please use the Feature Template. The steps are below:
- Click on the create new issue button.
- You will be given an option to select a template.
- Select the Feature tempalate.
- Start writing the issues based on the template.
For anything that does not fall into these two categories, then please do not use a template and create an issue from scratch.
An example would be if you have a question regarding implementation. Do not use the existing template but simply create the issues from a blank one. Steps are below:
- Click on the create new issue button.
- You will be given an option to select a template.
- Don't use a template and click on the "Open a blank issue." link.
- Start writing the issues.
If you are unsure that you are writing an issue as per our standards then simply follow the checklist below:
- I used the Bug Report template to report a bug/I used the Feature template to report a bug/I created a blank issues to create an issue not related to a bug or a new feature.
- I gave the issues a clear title that describes it well. When someone reads the title they should understand what the issues is for.
- I wrote a clear and descriptive issue.
- I gave the issue an appropriate label.