Issue Templates

When submitting an issue, most of the EdgeX repositories contain one or more issue templates.  The templates outline the data you should provide to help assist the project team understand the issue you are seeing and provide the correct amount of detail in order to find and address your issue.

When a repository has more than one issue template, you will be offered a menu to select the type of issue you want to file when you create a new issue.  Based on your selection from the menu (see the example issue menu for edgex-go shown below) Github will present you with the appropriate issue template to fill in.

Different fields are requested for different types of issues.  For example, on a Bug report issue, you would need to provide information about the error or exception that you encountered.  Please use the templates when submitting issues.  Do not remove template sections.  If a section in the template is not relevant in your issue, simply answer "n/a" in the field - which stands for "not applicable."  Also note that some fields in the template are listed as "REQUIRED".  These fields **must** be filled in and the issue should not be submitted without this data.

If the issue is submitted and it lacks the required fields or if it generally lacks insufficient information for the project to act on, it will have a "not enough information" label attached to it and no other work will be done on it until the author of the issue provides additional information.