mirror of
https://github.com/bybrooklyn/openbitdo.git
synced 2026-03-19 12:12:57 -04:00
release: prepare v0.0.1-rc.4
This commit is contained in:
@@ -1,60 +1,40 @@
|
||||
# Dirty-Room Collection Playbook (Decompiler-First Expansion)
|
||||
# Dirty-Room Collection Playbook
|
||||
|
||||
This playbook describes how dirty-room evidence is gathered and sanitized before the clean-room implementation consumes it.
|
||||
|
||||
## Goal
|
||||
Create sanitized, requirement-linked evidence that expands device detect/diagnostics support without contaminating clean-room implementation.
|
||||
|
||||
## Scope of This Wave
|
||||
- Evidence source: decompiler/static-only.
|
||||
- Target: Wave 2 +12 popularity cohort (plus previously tracked candidate-readonly set).
|
||||
- Promotion policy: no new `full` promotions in this wave.
|
||||
- Output artifacts: `spec/dossiers/**`, `spec/evidence_index.csv`, updated `spec/*.csv`, updated `requirements.yaml`.
|
||||
Produce sanitized, requirement-linked evidence that can expand detect, diagnostics, mapping, or firmware understanding without copying vendor material into the runtime.
|
||||
|
||||
## Allowed Dirty-Room Inputs
|
||||
- `/Users/brooklyn/data/8bitdo/decompiled_dll/8BitDo_Ultimate_Software_V2.decompiled.cs`
|
||||
- `/Users/brooklyn/data/8bitdo/decompiled/*.cs`
|
||||
- `/Users/brooklyn/data/8bitdo/decompiled_autoupdate/*.cs`
|
||||
- Existing dirty-room transcript files under `/Users/brooklyn/data/8bitdo/`
|
||||
## Allowed Inputs
|
||||
|
||||
## Required Sanitization Rules
|
||||
- Do not copy raw vendor/decompiled code snippets into clean artifacts.
|
||||
- Record only sanitized structure-level findings:
|
||||
- command intent
|
||||
- request/response byte-shape
|
||||
- validator expectations
|
||||
- gating/policy notes
|
||||
- Use requirement IDs only (`REQ-DR-*`, `REQ-PROM-*`, `REQ-COMM-*`, `REQ-GH-*`).
|
||||
- approved decompiler outputs and existing dirty-room transcripts
|
||||
- official public web pages used for naming or marketing confirmation
|
||||
|
||||
## Required Sanitization
|
||||
|
||||
Record only structure-level findings:
|
||||
|
||||
- command intent
|
||||
- request and response shape
|
||||
- validator expectations
|
||||
- retry or failure behavior
|
||||
- promotion or safety notes
|
||||
|
||||
Do not copy vendor code or raw proprietary snippets.
|
||||
|
||||
## Dossier Workflow
|
||||
1. Pick PID and operation group.
|
||||
2. Collect static evidence anchors (class/function names and behavior summaries).
|
||||
3. Derive sanitized command mapping and validation expectations.
|
||||
4. Write TOML dossier in `spec/dossiers/<pid_hex>/<operation_group>.toml`.
|
||||
5. Link dossier ID into `spec/command_matrix.csv` (`dossier_id` column).
|
||||
6. Update `spec/evidence_index.csv`.
|
||||
7. Ensure each Wave 2 PID has all three required dossier files:
|
||||
- `core_diag.toml`
|
||||
- `mode_or_profile_read.toml`
|
||||
- `firmware_preflight.toml`
|
||||
|
||||
## Authoring Approach (No Helper Scripts)
|
||||
- Dossiers and matrix updates are maintained directly in repository source files.
|
||||
- `spec/evidence_index.csv` is updated manually with deterministic ordering.
|
||||
- Validation is performed through normal repository review plus workspace tests.
|
||||
1. choose a PID and operation group
|
||||
2. collect anchors and summarize them
|
||||
3. create or update the sanitized dossier
|
||||
4. link the dossier from the relevant matrix rows
|
||||
5. update evidence indexes and notes
|
||||
|
||||
## Confidence Rules
|
||||
- `confirmed`: requires static + runtime + hardware confirmation (not achievable in this wave).
|
||||
- `inferred`: static-only or partial confidence.
|
||||
- For this wave, new entries should remain `inferred` unless already confirmed historically.
|
||||
## Promotion Rule
|
||||
|
||||
## Promotion Gate
|
||||
A device can move from `candidate-readonly` to `full` only when all three are true:
|
||||
1. static evidence complete
|
||||
2. runtime trace evidence complete
|
||||
3. hardware read/write/readback complete
|
||||
Moving from `read-only candidate` to `supported` requires:
|
||||
|
||||
## Review Checklist
|
||||
- Dossier contains required fields from schema.
|
||||
- Requirement linkage is explicit.
|
||||
- No raw decompiled text/snippets are present.
|
||||
- `support_tier` remains `candidate-readonly` for new no-hardware devices.
|
||||
- Runtime and hardware placeholders are populated with concrete promotion evidence tasks.
|
||||
1. static evidence
|
||||
2. runtime traces
|
||||
3. hardware confirmation
|
||||
|
||||
Reference in New Issue
Block a user