Skip to content

Issue Label Guide

Anthony Fabius edited this page Mar 25, 2023 · 2 revisions

This is a guide for the issue labels of the Food Finder repository. They are all pretty self explanatory but if you want some examples this is the place to be. (If new labels are added or removed please make an issue regarding updating this wiki page, thanks in advance).

Contents

Accessibility

Use this label for issues relating Accessibility. Ex. dark mode, color blind options, text size, etc. Most accessibility issues will also be UI related so add that tag as well.

Android

Use this label for issues relating to only Android devices. If the issue is also present on IOS devices do not use either either label and just specify in your issue.

Bug

Use this label for issues relating to bugs of any kind. If they are platform specific include that label as well.

Documentation

Use this label for issues relating to the documentation of code. This can be added to any issues. Ex. Incorrect documentation of functions, Updating documentation for a new feature, etc.

Enhancement

Use this label for issues relating to enhancing existing features. They should be on every enhancement request issue.

Feature

Use this label for issues that are about creating new features. They should be put on every feature request issue.

Good first issue

Use this label for issues that anyone new to Food Finder can work on. Most of these issues are small and require very little to no code changes.

iOS

Use this label for issues relating to only IOS devices. If the issue is also present on Android devices do not use either label and just specify in your issue.

Priority

Use this label for urgent issues. Only issues that disrupt a core feature of Food Finder or stop the app from working.

Question

Use this label for issues that are questions. They should only be used on question issues.

Suggestion

Use this label for issues suggesting new features or enhancements. If an issue has this tag it has not been confirmed yet so don't implement it. Once the tag is removed from the issue you make begin assignment and development of it. It is only used for Enhancement and Feature Requests.

UI

Use this label for issues relating to user interface of Food Finder. Ex. visual glitches, broken buttons, tabs/menus that don't work, etc.

Wiki

Use this label for issues relating to the Food Finder wiki. Ex. updating faq, updating old wiki pages, adding a new wiki page.