trent_larson/daily-notification-plugin
4
0
Fork 0
Code Issues Pull Requests 2 Projects Releases Wiki Activity

docs(feedback): Update feedback response plan with completion status

Browse Source 
Updated docs/FEEDBACK-RESPONSE-PLAN.md to reflect completion:
- Priority 1: Repo hygiene and version unification ✅
- Priority 2.2: TODO classification ✅
- Priority 3.1: CI workflows ✅
- Priority 4.1: Workspace package dist ✅
- Priority 5.1: Documentation consolidation ✅

All quick wins and infrastructure improvements complete.
Remaining: Priority 2.1 (Native plugin refactoring - larger work).
This commit is contained in:
Matthew Raymer
2025-12-23 09:53:43 +00:00
parent 74bb35048d
commit 65966b7cc7
1 changed files with 49 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files

92
docs/FEEDBACK-RESPONSE-PLAN.md
View File

@@ -9,18 +9,19 @@
## Priority 1: Quick Wins (High ROI, Low Risk)
### 1.1 Repo Hygiene ✅ IN PROGRESS
### 1.1 Repo Hygiene ✅ COMPLETE
- [x] Check what build artifacts are tracked in git
- [ ] Remove tracked build artifacts from git
- [ ] Strengthen `.gitignore` (add `*.tar.gz`, `build/reports/`, etc.)
- [ ] Verify `package.json` `files` field excludes build artifacts
- [ ] Clean up any nested archives
- [x] Remove tracked build artifacts from git (`.gradle/` files)
- [x] Strengthen `.gitignore` (add `*.tar.gz`, `build/reports/`, `.gradle/nb-cache/`, `packages/*/dist/`)
- [x] Verify `package.json` `files` field excludes build artifacts
- [x] Clean up any nested archives
### 1.2 Version Unification ✅ IN PROGRESS
- [ ] Update `README.md` version from 2.2.0 → 1.0.11
- [ ] Update `src/definitions.ts` version from 2.0.0 → 1.0.11
- [ ] Add CI check script to verify version consistency
- [ ] Document version policy: `package.json` is source of truth
### 1.2 Version Unification ✅ COMPLETE
- [x] Update `README.md` version from 2.2.0 → 1.0.11
- [x] Update `src/definitions.ts` version from 2.0.0 → 1.0.11
- [x] Add CI check script to verify version consistency (`scripts/check-version-consistency.sh`)
- [x] Integrate version check into `scripts/verify.sh`
- [x] Document version policy: `package.json` is source of truth
---
@@ -39,26 +40,29 @@
- `FetcherBridge`
- [ ] Implement refactoring in small, mergeable batches
### 2.2 TODO Classification
- [ ] Audit all TODOs/FIXMEs/HACKs (found 34 instances)
- [ ] Classify into:
- **Must ship** (correctness, rate-limits, TTL, scheduling)
- **Nice-to-have** (perf metrics, stats, diagnostics)
- **Future** (Phase 2)
- [ ] Create issues for "must ship" items
### 2.2 TODO Classification ✅ COMPLETE
- [x] Audit all TODOs/FIXMEs/HACKs (found 34 instances)
- [x] Classify into:
- **Must ship**: 7 items (rolling window logic, TTL validation, database operations)
- **Nice-to-have**: 2 items (performance metrics/statistics)
- **Future (Phase 2/3)**: 19 items (explicitly deferred features)
- **TypeScript Stubs**: 3 items (iOS-specific stubs)
- [x] Create comprehensive classification document (`docs/TODO-CLASSIFICATION.md`)
- [ ] Create issues for "must ship" items (7 issues needed)
- [ ] Move "Phase 2" items behind feature flags or to planning docs
---
## Priority 3: CI/CD Infrastructure (High ROI, Low Risk)
### 3.1 CI Workflows
- [ ] Create `.github/workflows/ci.yml`:
- Node/TS: lint, typecheck, unit tests, build, `npm pack` check
- Android: `./gradlew test` + `lint` + `assembleDebug`
- iOS: `xcodebuild test` (macOS runner)
- [ ] Add merge gates on CI passing
- [ ] Document CI setup in `ci/README.md`
### 3.1 CI Workflows ✅ COMPLETE
- [x] Create `.github/workflows/ci.yml`:
- Node/TS: lint, typecheck, build, local CI, `npm pack` check
- Android: `./gradlew test` + `lint` (with graceful fallbacks)
- iOS: `xcodebuild test` (macOS runner, with graceful fallbacks)
- [x] Add graceful fallbacks for standalone plugin context
- [ ] Add merge gates on CI passing (requires GitHub repo settings)
- [x] Document CI setup in `ci/README.md` (already documented)
### 3.2 Test Coverage
- [ ] Identify critical paths needing tests:
@@ -73,31 +77,33 @@
## Priority 4: Packaging & Workspace (Medium ROI, Low Risk)
### 4.1 Workspace Package Dist
- [ ] Check if `packages/polling-contracts/dist/` is committed
- [ ] If committed, remove from git
- [ ] Add `prepack` script to build subpackage before publish
- [ ] Update `package.json` `files` to control publishing
### 4.1 Workspace Package Dist ✅ COMPLETE
- [x] Check if `packages/polling-contracts/dist/` is committed (not tracked in git)
- [x] Add `packages/*/dist/` to `.gitignore` to prevent future commits
- [x] Verify `package.json` `files` field controls publishing (already correct)
- [ ] Add `prepack` script to build subpackage before publish (optional enhancement)
---
## Priority 5: Documentation (Low ROI, Low Risk)
### 5.1 Documentation Consolidation
- [ ] Update `README.md` with clear entry points:
- Install
- Minimal usage example
- Platform setup (Android/iOS)
### 5.1 Documentation Consolidation ✅ COMPLETE
- [x] Update `README.md` with clear entry points:
- Quick Start section with links to getting started guide, examples, troubleshooting
- Install instructions (already in Getting Started guide)
- Minimal usage example (linked to Quick Start guide)
- Platform setup (linked to Getting Started guide)
- Troubleshooting link
- Architecture link
- [ ] Add Compatibility Matrix:
- Capacitor versions supported
- Android minSdk/targetSdk
- iOS min version
- Exact alarm behavior notes per Android version
- [ ] Add Behavioral Contracts section:
- Guaranteed behaviors (monotonic watermark, idempotency, TTL)
- Best-effort behaviors (delivery in Doze, background fetch timing)
- Architecture link (via Documentation Index)
- [x] Add Compatibility Matrix:
- Capacitor versions supported (table with status)
- Android minSdk/targetSdk (23/35, with permission notes)
- iOS min version (13.0)
- Electron requirements (20+)
- Platform support summary table
- [x] Add Behavioral Contracts section:
- Guaranteed behaviors (monotonic watermark, idempotency, TTL, persistence, recovery)
- Best-effort behaviors (delivery in Doze, background fetch timing, battery optimization)
---