|
| 1 | +# Changelog |
| 2 | + |
| 3 | +All notable changes to this project will be documented in this file. |
| 4 | + |
| 5 | +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), |
| 6 | +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). |
| 7 | + |
| 8 | +## [Unreleased] |
| 9 | + |
| 10 | +### Planned (Phase 2 - Weeks 5-8) |
| 11 | +- Reservoir computing (Echo State Network) for context compression |
| 12 | +- RAG system with embedding model and vector database |
| 13 | +- Knowledge graph for project relationship tracking |
| 14 | +- SQLite persistence for conversation history |
| 15 | + |
| 16 | +### Planned (Phase 3 - Weeks 9-12) |
| 17 | +- Mixture of Experts (MoE) with specialized models |
| 18 | +- Bayesian decision engine for confidence scoring |
| 19 | +- Background monitoring for proactive assistance |
| 20 | + |
| 21 | +### Planned (Phase 4 - Months 4+) |
| 22 | +- Spiking Neural Networks for ultra-low-power wake detection |
| 23 | +- Reinforcement learning for personalized routing |
| 24 | +- On-device fine-tuning capabilities |
| 25 | + |
| 26 | +## [0.1.0] - 2025-11-22 |
| 27 | + |
| 28 | +### Added |
| 29 | +- **Phase 1 MVP**: Complete hybrid AI orchestrator implementation |
| 30 | +- **Expert System** (`src/expert.rs`): |
| 31 | + - Rule-based safety enforcement |
| 32 | + - Privacy protection (API key/password detection) |
| 33 | + - Configurable safety rules with IDs and descriptions |
| 34 | + - Explainable blocking decisions |
| 35 | +- **Router** (`src/router.rs`): |
| 36 | + - Heuristic-based query routing (local vs. remote) |
| 37 | + - Keyword detection for complex reasoning |
| 38 | + - Length-based routing decisions |
| 39 | + - Confidence scoring |
| 40 | +- **Context Manager** (`src/context.rs`): |
| 41 | + - In-memory conversation history (last 100 turns) |
| 42 | + - Project-specific context switching |
| 43 | + - JSON serialization/deserialization for persistence |
| 44 | + - Context snapshots for query augmentation |
| 45 | +- **Orchestrator** (`src/orchestrator.rs`): |
| 46 | + - Main pipeline coordinating all components |
| 47 | + - Safety-first processing (expert system first) |
| 48 | + - Error handling and graceful degradation |
| 49 | + - Offline-first by default |
| 50 | +- **CLI Interface** (`src/main.rs`): |
| 51 | + - Interactive mode with commands (`/project`, `/history`, `/clear`) |
| 52 | + - Single-query mode |
| 53 | + - Project context support |
| 54 | + - Verbose output mode (VERBOSE=1) |
| 55 | +- **Type System** (`src/types.rs`): |
| 56 | + - `Query`, `Response`, `RoutingDecision` core types |
| 57 | + - Serializable data structures |
| 58 | + - Zero-copy where possible |
| 59 | + |
| 60 | +### Documentation |
| 61 | +- **README.md**: Comprehensive project overview |
| 62 | +- **claude.md**: Detailed architecture documentation (10,000+ words) |
| 63 | +- **SECURITY.md**: Security policy and vulnerability reporting |
| 64 | +- **CONTRIBUTING.md**: Contribution guidelines with TPCF explanation |
| 65 | +- **CODE_OF_CONDUCT.md**: Contributor Covenant v2.1 + project-specific additions |
| 66 | +- **MAINTAINERS.md**: Perimeter structure and decision-making process |
| 67 | +- **CHANGELOG.md**: This file |
| 68 | +- **LICENSE.txt**: Dual MIT + Palimpsest-0.8 licensing |
| 69 | + |
| 70 | +### Testing |
| 71 | +- Unit tests for all core components (>90% coverage) |
| 72 | +- Expert system safety rule tests |
| 73 | +- Router decision logic tests |
| 74 | +- Context manager serialization tests |
| 75 | +- Orchestrator integration tests |
| 76 | + |
| 77 | +### Infrastructure |
| 78 | +- **Cargo.toml**: Rust project configuration with RSR metadata |
| 79 | +- **justfile**: Task automation (build, test, validate) |
| 80 | +- **flake.nix**: Nix reproducible build specification |
| 81 | +- **.gitlab-ci.yml**: CI/CD pipeline configuration |
| 82 | +- **.well-known/**: RFC 9116 security.txt, ai.txt, humans.txt |
| 83 | + |
| 84 | +### RSR Compliance |
| 85 | +- ✅ Bronze-level Rhodium Standard Repository compliance |
| 86 | +- ✅ Zero `unsafe` blocks (`#![forbid(unsafe_code)]`) |
| 87 | +- ✅ Type safety (Rust compile-time guarantees) |
| 88 | +- ✅ Memory safety (ownership model) |
| 89 | +- ✅ Offline-first (network is optional feature) |
| 90 | +- ✅ Minimal dependencies (2 required: serde, serde_json) |
| 91 | +- ✅ TPCF Perimeter 3 (Community Sandbox) |
| 92 | + |
| 93 | +### Build Configuration |
| 94 | +- Release profile optimized for size (`opt-level = "z"`) |
| 95 | +- LTO and single codegen-unit for maximum optimization |
| 96 | +- Stripped binaries for production |
| 97 | +- Feature flags for optional network functionality |
| 98 | + |
| 99 | +## [0.0.0] - 2025-11-22 |
| 100 | + |
| 101 | +### Added |
| 102 | +- Initial repository setup |
| 103 | +- Git initialization |
| 104 | +- Branch: `claude/offline-mobile-docs-01TVXFHwwzW6f2o7CSS7xUSG` |
| 105 | + |
| 106 | +--- |
| 107 | + |
| 108 | +## Version History Summary |
| 109 | + |
| 110 | +| Version | Date | Description | RSR Level | |
| 111 | +|---------|------|-------------|-----------| |
| 112 | +| **0.1.0** | 2025-11-22 | Phase 1 MVP | Bronze ✅ | |
| 113 | +| 0.2.0 | TBD | Phase 2 (Reservoir + RAG) | Silver (goal) | |
| 114 | +| 0.3.0 | TBD | Phase 3 (MoE + Bayesian) | Silver | |
| 115 | +| 1.0.0 | TBD | Production-ready | Gold (goal) | |
| 116 | + |
| 117 | +--- |
| 118 | + |
| 119 | +## Upgrade Guide |
| 120 | + |
| 121 | +### From 0.0.0 to 0.1.0 |
| 122 | + |
| 123 | +**Breaking Changes**: None (initial release) |
| 124 | + |
| 125 | +**New Features**: |
| 126 | +- Full Phase 1 MVP functionality |
| 127 | +- CLI interface for interactive and single-query modes |
| 128 | + |
| 129 | +**Migration**: |
| 130 | +```bash |
| 131 | +# Build from source |
| 132 | +git pull origin main |
| 133 | +cargo build --release |
| 134 | +./target/release/mobile-ai --help |
| 135 | +``` |
| 136 | + |
| 137 | +### Future: From 0.1.0 to 0.2.0 (Planned) |
| 138 | + |
| 139 | +**Expected Breaking Changes**: |
| 140 | +- Context manager API will change (SQLite persistence) |
| 141 | +- Reservoir state added to `ContextSnapshot` |
| 142 | +- New configuration options for RAG |
| 143 | + |
| 144 | +**Migration Guide**: Will be provided in 0.2.0 release |
| 145 | + |
| 146 | +--- |
| 147 | + |
| 148 | +## Development Cycle |
| 149 | + |
| 150 | +**Release Cadence**: |
| 151 | +- **Phase 1**: Initial release (0.1.0) |
| 152 | +- **Phase 2-4**: Monthly feature releases (0.2.0, 0.3.0, etc.) |
| 153 | +- **Patch releases**: As needed for critical bugs/security |
| 154 | + |
| 155 | +**Branching Strategy**: |
| 156 | +- `main`: Stable releases only |
| 157 | +- `develop`: Integration branch for Phase work |
| 158 | +- `feature/*`: Individual feature branches |
| 159 | +- `hotfix/*`: Security/critical bug fixes |
| 160 | + |
| 161 | +**Versioning**: |
| 162 | +- **MAJOR**: Breaking API changes, architectural overhauls |
| 163 | +- **MINOR**: New features, Phase milestones |
| 164 | +- **PATCH**: Bug fixes, documentation, non-breaking improvements |
| 165 | + |
| 166 | +--- |
| 167 | + |
| 168 | +## Deprecation Policy |
| 169 | + |
| 170 | +**Notice Period**: 2 minor versions (e.g., deprecated in 0.2.0, removed in 0.4.0) |
| 171 | + |
| 172 | +**Announcement**: |
| 173 | +1. Add `#[deprecated]` attribute to code |
| 174 | +2. Add CHANGELOG entry under "Deprecated" |
| 175 | +3. Update documentation with migration path |
| 176 | +4. Emit compiler warnings |
| 177 | + |
| 178 | +**Example**: |
| 179 | +```rust |
| 180 | +#[deprecated(since = "0.2.0", note = "Use `new_api()` instead")] |
| 181 | +pub fn old_api() { ... } |
| 182 | +``` |
| 183 | + |
| 184 | +--- |
| 185 | + |
| 186 | +## Security Updates |
| 187 | + |
| 188 | +Security fixes will be released as **patch versions** and backported to supported major versions. |
| 189 | + |
| 190 | +**Supported Versions**: |
| 191 | +- Latest minor version: ✅ Full support |
| 192 | +- Previous minor version: ⚠️ Security fixes only |
| 193 | +- Older versions: ❌ Unsupported (upgrade recommended) |
| 194 | + |
| 195 | +See [SECURITY.md](SECURITY.md) for vulnerability reporting. |
| 196 | + |
| 197 | +--- |
| 198 | + |
| 199 | +## Links |
| 200 | + |
| 201 | +- **Repository**: https://github.com/Hyperpolymath/heterogenous-mobile-computing |
| 202 | +- **Documentation**: [claude.md](claude.md), [README.md](README.md) |
| 203 | +- **Issues**: https://github.com/Hyperpolymath/heterogenous-mobile-computing/issues |
| 204 | +- **Releases**: https://github.com/Hyperpolymath/heterogenous-mobile-computing/releases |
| 205 | + |
| 206 | +--- |
| 207 | + |
| 208 | +*This changelog is maintained by Perimeter 1 maintainers. All notable changes must be documented here.* |
| 209 | + |
| 210 | +*Format: [Keep a Changelog](https://keepachangelog.com/)* |
| 211 | +*Versioning: [Semantic Versioning](https://semver.org/)* |
0 commit comments