Bug or Feature?

[ericsizemore]

Is this a bug or a feature?

Determining whether a proposed change is a bug fix or a new feature can sometimes be ambiguous. This document aims to provide clarity on the categorization process to facilitate effective software development and communication.

Bug

Bugs are unintended errors in the behavior of the software that cause problems and may occur under specific conditions. They can negatively impact user experience and often require immediate attention.

Characteristics

• Unintentional: Bugs are not part of the intended functionality of the software.
• Problematic: They cause issues or errors in the system's behavior.
• Conditional Occurrence: Bugs may only manifest under specific conditions.

Examples:

• Errors when calling the library via CLI or PHAR binary
• Runtime errors when using any of the library functions
• With proper use and data, the library returns the wrong output for a given clover file

Feature

Features define planned functionality that enhances the software or introduces new capabilities. They are intentional changes aimed at improving user experience or extending the software's functionality.

Characteristics

• Planned Functionality: Features are purposefully designed to improve the software.
• Enhancement or Addition: They involve the introduction of new functions, classes, or improvements to existing ones.
• User Benefits: Features aim to enhance user experience or provide new capabilities.

Examples

• Introduction of a new command to perform a specific task.
• Enhancement of an existing command/class to handle additional use cases.
• Introduction of a new commands/options to provide new functionality.