Add comprehensive documentation for flakestorm

- Introduced multiple new documents including API Specification, Configuration Guide, Contributing Guide, Developer FAQ, Implementation Checklist, Module Documentation, Publishing Guide, Test Scenarios, Testing Guide, and Usage Guide.
- Each document provides detailed instructions, examples, and best practices for using and contributing to flakestorm.
- Enhanced overall project documentation to support users and developers in understanding and utilizing the framework effectively.
This commit is contained in:
Entropix 2025-12-29 11:33:01 +08:00
parent 69e0f8deeb
commit ee10da0b97
10 changed files with 124 additions and 134 deletions

View file

@ -137,7 +137,7 @@ flakestorm/
```bash
git commit -m "feat: Add new mutation type for XXX"
```
Use conventional commits:
- `feat:` New feature
- `fix:` Bug fix
@ -192,15 +192,15 @@ flakestorm/
```python
class TestMyFeature:
"""Tests for MyFeature."""
def test_happy_path(self):
"""Test normal operation."""
...
def test_edge_case(self):
"""Test edge case handling."""
...
def test_error_handling(self):
"""Test error conditions."""
...
@ -238,20 +238,20 @@ async def test_mutation_generation(mock_client):
def function_name(param1: str, param2: int = 10) -> bool:
"""
Brief description of function.
Longer description if needed. Explain what the function
does, not how it does it.
Args:
param1: Description of param1
param2: Description of param2
Returns:
Description of return value
Raises:
ValueError: When param1 is empty
Example:
>>> result = function_name("test")
>>> print(result)
@ -288,4 +288,3 @@ Contributors are recognized in:
- GitHub contributors page
Thank you for contributing to flakestorm!