GitHub Issue Conventions

This document outlines the standards and conventions for creating issues in our GitHub repository. These guidelines help us maintain a consistent, understandable, and actionable list of issues.

Issue Naming

Each issue should be named following the format below:

[TYPE]: Brief Description

- `[TYPE]`: This is a short tag that represents the category of the issue.

- `Brief Description`: This should be a clear and concise explanation of the issue.

Types of Issues

The type tag is mandatory and should be one of the following:

1. **[FEAT]:** Short for "feature". Use this tag when the issue is about a new feature that should be added to the project.

2. **[BUG]:** Use this tag when the issue is reporting a bug or malfunction in the project.

3. **[FIX]:** Use this label when the issue is related to fixing an existing problem in the code.

4. **[DOC]:** Short for "documentation". Use this tag when the issue is related to documentation, like README files, wikis, or in-code comments.

5. **[REFAC]:** Short for "refactor". Use this when the issue involves refactoring existing code to improve readability, structure, or performance without changing its external behavior.

6. **[TEST]:** Use this label when the issue is related to testing -- it might involve creating new tests, fixing existing ones, or improving test coverage or methodologies.

7. **[STYLE]:** Use this tag when the issue is related to code style -- it could involve fixing formatting, correcting typos, or complying with code style guidelines.

8. **[CHORE]:** Use this when the issue involves routine work or maintenance tasks that don't directly change the project's functionality, such as project setup, package updates, or configuring tools.

Example

Here's an example of how to name an issue:

[FEAT]: Implement Two-Factor Authentication

This helps in quickly identifying the nature of the issue at a glance and makes it easy for the team members to filter and search through the issues.

By adhering to these guidelines, we can ensure a well-organized, easily navigable, and actionable list of project issues. Always refer back to this document if you're unsure about how to name an issue.