📝 docs: add @nice_to_have tag to BDD test documentation
This commit is contained in:
@@ -18,6 +18,7 @@ Used to categorize tests by importance:
|
|||||||
- `@critical` - Critical path tests that must always pass
|
- `@critical` - Critical path tests that must always pass
|
||||||
- `@basic` - Basic functionality tests
|
- `@basic` - Basic functionality tests
|
||||||
- `@advanced` - Advanced or edge case scenarios
|
- `@advanced` - Advanced or edge case scenarios
|
||||||
|
- `@nice_to_have` - Optional features that would be nice to have but aren't critical
|
||||||
|
|
||||||
### Component Tags
|
### Component Tags
|
||||||
Used to categorize tests by system component:
|
Used to categorize tests by system component:
|
||||||
@@ -32,6 +33,24 @@ Used to exclude tests from execution:
|
|||||||
- `@todo` - Tests with pending step implementations
|
- `@todo` - Tests with pending step implementations
|
||||||
- `@skip` - Tests that should be skipped entirely
|
- `@skip` - Tests that should be skipped entirely
|
||||||
|
|
||||||
|
### Nice-to-Have Tag
|
||||||
|
|
||||||
|
The `@nice_to_have` tag is used to mark scenarios that test optional features or enhancements. These are features that would be beneficial to have but aren't critical for the core functionality of the system.
|
||||||
|
|
||||||
|
**Usage:**
|
||||||
|
- Add `@nice_to_have` to scenarios testing optional features
|
||||||
|
- These scenarios are typically excluded from critical path testing
|
||||||
|
- Useful for marking "stretch goal" functionality
|
||||||
|
|
||||||
|
**Example:**
|
||||||
|
```gherkin
|
||||||
|
@nice_to_have @greet
|
||||||
|
Scenario: Greeting with custom formatting options
|
||||||
|
Given the server is running
|
||||||
|
When I request a greeting with bold formatting
|
||||||
|
Then the response should contain HTML bold tags
|
||||||
|
```
|
||||||
|
|
||||||
### Work In Progress Tag
|
### Work In Progress Tag
|
||||||
Used to override exclusions for active development:
|
Used to override exclusions for active development:
|
||||||
- `@wip` - Work In Progress - overrides exclusion tags to allow focused development
|
- `@wip` - Work In Progress - overrides exclusion tags to allow focused development
|
||||||
@@ -206,6 +225,7 @@ Feature: Health Endpoint
|
|||||||
| `@critical` | Critical path | `@critical` on essential scenarios |
|
| `@critical` | Critical path | `@critical` on essential scenarios |
|
||||||
| `@basic` | Basic functionality | `@basic` on standard scenarios |
|
| `@basic` | Basic functionality | `@basic` on standard scenarios |
|
||||||
| `@advanced` | Advanced scenarios | `@advanced` on edge cases |
|
| `@advanced` | Advanced scenarios | `@advanced` on edge cases |
|
||||||
|
| `@nice_to_have` | Optional features | `@nice_to_have` on stretch goal scenarios |
|
||||||
| `@auth` | Authentication | `@auth` on auth features |
|
| `@auth` | Authentication | `@auth` on auth features |
|
||||||
| `@config` | Configuration | `@config` on config scenarios |
|
| `@config` | Configuration | `@config` on config scenarios |
|
||||||
| `@api` | API endpoints | `@api` on endpoint tests |
|
| `@api` | API endpoints | `@api` on endpoint tests |
|
||||||
|
|||||||
Reference in New Issue
Block a user