Skip to content

Commit 2e47b69

Browse files
author
Alex J Lennon
committed
docs: align roadmap with issues #9#11, CI state, contribution areas
- README: replace stale v0.x checkboxes with issue-linked table; refresh status footer; link replay to #10 - CONTRIBUTING: issue tracking + CI overview (Zephyr E2E); contribution areas point to open issues Made-with: Cursor
1 parent faf6395 commit 2e47b69

2 files changed

Lines changed: 32 additions & 47 deletions

File tree

CONTRIBUTING.md

Lines changed: 17 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -107,9 +107,11 @@ RUN_E2E_ZEPHYR_NATIVE=1 ./scripts/validate_local.sh
107107

108108
Work is tracked in [GitHub issues](https://github.com/DynamicDevices/rsgdb/issues). **Blocked-by** dependencies define order (e.g. Part A **#1#3**; **#2** can run in parallel). Close an issue from a PR with `Closes #N` when it is fully done.
109109

110-
**Status (short):** Part A (**#1#3**), session recording (**#4**), SVD (**#5**), breakpoint/semihosting spike (**#6**), flash orchestration (**#7**) are closed. **RTOS awareness (#8):** pass-through + decode/log for thread RSP (`rsgdb::rtos`, Zephyr-first docs in README). **Automated checks:** `cargo test`, `tests/proxy_integration.rs`, `./scripts/validate_local.sh`, CI **E2E GDB smoke**. **Next:** **#9** (native probe backend).
110+
**Status (short):** Part A (**#1#3**), session recording (**#4**), SVD baseline (**#5**), breakpoint/semihosting spike (**#6**), flash orchestration (**#7**), RTOS decode/log (**#8**) are **closed**. **Phase A/B** (RSP matrix + proxy tests, gdbinit, backend thread reply logging) are in-tree; see README. **CI:** main workflow (**CI**) + optional **Zephyr E2E** (`native_sim`, debug `rsgdb`, west venv + `pyelftools`) — both green on `main`.
111111

112-
**CI jobs (overview):** `test` (matrix), `fmt`, `clippy`, `docs`, `e2e-gdb-smoke`, `coverage`, `build` (artifacts).
112+
**Next roadmap issues (open):** [#9](https://github.com/DynamicDevices/rsgdb/issues/9) native probe backend, [#10](https://github.com/DynamicDevices/rsgdb/issues/10) session replay from JSONL, [#11](https://github.com/DynamicDevices/rsgdb/issues/11) richer SVD (fields/enums).
113+
114+
**CI jobs (overview):** Workflow **CI**: `test` (matrix), `fmt`, `clippy`, `docs`, `e2e-gdb-smoke`, `coverage`, `build` (artifacts; upload may use `continue-on-error` for transient infra). Workflow **Zephyr E2E**: west + SDK + `scripts/e2e_zephyr_native_sim.sh` (path / schedule / `workflow_dispatch`).
113115

114116
**Design ADRs:** [docs/ADR-001-breakpoints-semihosting.md](docs/ADR-001-breakpoints-semihosting.md) — breakpoint policy + semihosting (Phase 2 spike).
115117

@@ -322,26 +324,19 @@ rsgdb/
322324

323325
## Areas for Contribution
324326

325-
We welcome contributions in these areas:
326-
327-
### High Priority
328-
- [ ] GDB RSP protocol implementation
329-
- [ ] Backend integrations (probe-rs, OpenOCD)
330-
- [ ] Breakpoint management system
331-
- [ ] State tracking and inspection
332-
333-
### Medium Priority
334-
- [ ] Session recording/replay
335-
- [ ] TUI interface
336-
- [ ] SVD peripheral decoding
337-
- [ ] Performance optimizations
338-
339-
### Always Welcome
340-
- Documentation improvements
341-
- Test coverage expansion
342-
- Bug fixes
343-
- Example code
344-
- Performance improvements
327+
We welcome contributions in these areas (see **[open issues](https://github.com/DynamicDevices/rsgdb/issues?q=is%3Aopen+is%3Aissue)** for current priorities):
328+
329+
### High priority (roadmap)
330+
- [ ] **Native probe / backend abstraction**[#9](https://github.com/DynamicDevices/rsgdb/issues/9)
331+
- [ ] **Session replay from JSONL**[#10](https://github.com/DynamicDevices/rsgdb/issues/10)
332+
333+
### Medium priority
334+
- [ ] **Richer SVD (fields, enums)**[#11](https://github.com/DynamicDevices/rsgdb/issues/11)
335+
- [ ] TUI, advanced breakpoints, logging export — open an issue before large changes
336+
337+
### Always welcome
338+
- Documentation and test coverage (RSP matrix, proxy integration, SVD fixtures)
339+
- Bug fixes and small ergonomics (gdbinit, logging targets)
345340

346341
## Getting Help
347342

README.md

Lines changed: 15 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ When enabled, each GDB↔backend connection writes one **JSON Lines** file under
148148

149149
**Enable:** `rsgdb --record`, or set `[recording] enabled = true` in config, or `RSGDB_RECORD=1`. Optional directory override: `--record-dir DIR` or `RSGDB_RECORD_DIR`.
150150

151-
**Replay:** There is no built-in replayer yet. Inspect `.jsonl` with your usual tools or `jq`; a future release may add a mock server for automated replay.
151+
**Replay:** There is no built-in replayer yet. Inspect `.jsonl` with your usual tools or `jq`. Work is tracked as [#10](https://github.com/DynamicDevices/rsgdb/issues/10) (mock / automated playback for regression tests).
152152

153153
### Flash orchestration (`rsgdb flash`)
154154

@@ -285,29 +285,19 @@ We welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guid
285285

286286
## 📋 Roadmap
287287

288-
### v0.1.0 - Foundation (Current)
289-
- [x] Project setup and structure
290-
- [ ] Basic RSP protocol parser
291-
- [ ] Simple pass-through proxy
292-
- [ ] Configuration system
293-
- [ ] Basic logging
294-
295-
### v0.2.0 - Core Features
296-
- [ ] Enhanced logging with filtering
297-
- [ ] Breakpoint management
298-
- [ ] State tracking
299-
- [ ] Memory inspection
300-
301-
### v0.3.0 - Backend Support
302-
- [ ] probe-rs integration
303-
- [ ] OpenOCD support
304-
- [ ] Backend abstraction layer
305-
306-
### v0.4.0 - Advanced Features
307-
- [ ] Session recording/replay
308-
- [ ] TUI interface
309-
- [ ] SVD peripheral decoding
310-
- [ ] Performance optimizations
288+
Source of truth for ordering and scope: **[GitHub Issues](https://github.com/DynamicDevices/rsgdb/issues)** (labels `roadmap`, `enhancement`).
289+
290+
| Milestone (docs) | What it means | Issue |
291+
|------------------|---------------|-------|
292+
| **Foundation + proxy** | RSP codec, TCP proxy, config, logging, CI (incl. GDB + Zephyr E2E), session record (JSONL), SVD labels, flash orchestration, RTOS decode/log | Closed: [#1#8](https://github.com/DynamicDevices/rsgdb/issues?q=is%3Aissue+is%3Aclosed) |
293+
| **Next: native backend** | Probe-facing `Backend` (not only TCP stub) | [#9](https://github.com/DynamicDevices/rsgdb/issues/9) (open) |
294+
| **Next: replay** | Playback / mock backend from `.jsonl` recordings | [#10](https://github.com/DynamicDevices/rsgdb/issues/10) (open) |
295+
| **Next: richer SVD** | Fields, enums, correlation with recordings | [#11](https://github.com/DynamicDevices/rsgdb/issues/11) (open) |
296+
297+
Older versioned bullets (v0.2–v0.4) below are **aspirational**; issue titles supersede them.
298+
299+
### Aspirational (not scheduled per-issue yet)
300+
- Enhanced logging export (JSON/CSV), advanced breakpoints, TUI, performance work — see **Planned** under Key Features and open an issue when starting.
311301

312302
## 📄 License
313303

@@ -331,4 +321,4 @@ You may choose either license for your use.
331321

332322
---
333323

334-
**Status**: 🚧 Early Development - Not yet ready for production use
324+
**Status**: 🚧 Early development — CI green on `main` (multi-OS tests, GDB smoke, Zephyr `native_sim` E2E). Not a substitute for a production-qualified probe stack until native backends and release hardening land; see issues above.

0 commit comments

Comments
 (0)