Skip to content

Commit 6cf9e7e

Browse files
author
Fernando López
committed
Update Refactoring plan
1 parent 5516c16 commit 6cf9e7e

1 file changed

Lines changed: 13 additions & 6 deletions

File tree

doc/Refactoring.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,13 @@ This refactoring plan aims to improve modularity, maintainability, test clarity,
1111
**Goal:** Understand current structure, execution flow, and test coverage.
1212

1313
- [ ] Run tests locally using `behave` and Docker Compose.
14+
1415
- Evaluate:
1516
- [ ] Test coverage & stability
1617
- [ ] Code duplication
1718
- [ ] Docker reliability
1819
- [ ] BDD feature file readability
20+
1921
- Missing tutorials:
2022
- NGSIv2:
2123
- [ ] 106. Subscribing to Changes in Context
@@ -46,6 +48,7 @@ This refactoring plan aims to improve modularity, maintainability, test clarity,
4648
├── ngsi_v2/
4749

4850
└── ngsi_ld/
51+
4952
- [ ] Unify or reuse shared step definitions.
5053

5154
---
@@ -93,17 +96,21 @@ This refactoring plan aims to improve modularity, maintainability, test clarity,
9396
**Goal:** Automatically generate `.feature` files from HTML documentation using GenAI.
9497

9598
- **Use case:** HTML docs with `curl` examples (requests + responses).
99+
96100
- **Tooling:**
97101
- Use ChatGPT API or local LLM to:
98102
1. [ ] Parse HTML documentation.
99103
2. [ ] Extract `curl` requests + responses.
100104
3. [ ] Generate `.feature` files in Gherkin syntax (with `Given`, `When`, `Then` steps).
105+
101106
- **Workflow:**
102107
- [ ] Create `tools/genai_from_html.py`
103108
- [ ] Input: URL or HTML file.
104109
- [ ] Output: Suggested `.feature` files saved under `features/generated/`
110+
105111
- **Review process:**
106112
- [ ] Generated scenarios reviewed by dev or QA before merge.
113+
107114
- **Benefits:**
108115
- Fast onboarding for new tutorials.
109116
- Coverage parity with updated FIWARE docs.
@@ -153,19 +160,19 @@ This refactoring plan aims to improve modularity, maintainability, test clarity,
153160

154161
**Goal:** Allow reuse of helper modules via pip package.
155162

156-
- Add `setup.py` or `pyproject.toml`
157-
- Versioning for releases
158-
- Publish on PyPI (optional)
163+
- [ ] Add `setup.py` or `pyproject.toml`
164+
- [ ] Versioning for releases
165+
- [ ] Publish on PyPI (optional)
159166

160167
---
161168

162169
## 🧩 11. Final Review & Maintenance
163170

164171
**Goal:** Wrap up and ensure long-term quality.
165172

166-
- Peer review of refactored code
167-
- Merge changes incrementally
168-
- Document maintenance cycles and long-term goals
173+
- [ ] Peer review of refactored code
174+
- [ ] Merge changes incrementally
175+
- [ ] Document maintenance cycles and long-term goals
169176

170177
---
171178

0 commit comments

Comments
 (0)