Issues - UTACM/TexasACM.org GitHub Wiki

Labels

When making issues, there are a lot of tools we use to make sure that the issues are categorized properly. One of the biggest tools we use are labels.

Label Descriptions

• Bad Style: The existing code is either bad practice or bad style, and should be fixed.
• Bug: Something isn't working as expected. You usually want to try to fix these first, but they often take quite a while to diagnose.
• Content: These are usually our least technical bugs. This label is used for issues where we just need to change photos or text on the website.
• Enhancement: Something we can change to improve the website/add functionality.
• Feature Request: Used for big features that we want to add like a new page, new section, or new tool.
• Invalid: Used to mark an invalid issue. We rarely use this since most of the issues come directly form the Web Office.
• Priority: An issue that needs to be fixed ASAP. They are the most urgent issues.
• Tech Debt: An issue that will cost us a lot of work or frustration in the future, but can be a quick fix right now.
• Wiki: Something to be added to the wiki.

These are not hard guidelines, and you should just use the labels that you feel apply best. If you're unsure, just add the label anyways as it won't hurt.

Closing Issues

You can close issues directly through the issue's specific page, but you can close it automatically with a commit by adding any of these keywords, followed by the issue number:

• close
• closes
• closed
• fix
• fixes
• fixed
• resolve
• resolves
• resolved

For example, to close issue #123, you can put closes #123 in your commit message.