ff89e2fb0c
Added community-ready documentation and policies: CHANGELOG.md: - Keep a Changelog format with semantic versioning - Complete v3.5.0 release notes - All 6 core services documented - 4 support services listed - Installation instructions - Upgrade guide section - Links to documentation and releases SECURITY.md: - Vulnerability reporting policy (security@agenticgovernance.digital) - Supported versions table - Security best practices for implementers - Environment, network, deployment, database, API security - Known security considerations - Compliance information (OWASP Top 10) - Security audit history README.md improvements: - Added release badge (v3.5.0) - Added Node.js and MongoDB version badges - Links to CHANGELOG.md and SECURITY.md at top - Improved structure with clear sections - Better code examples with context - Added citation section (BibTeX format) - Removed references to deleted files (systemd/, ADR-001) - Corrected test counts (17 tests, not 625) - Added Discussions link - Professional status indicator GitHub Discussions: - Enabled via API for community engagement Result: Repository now has professional documentation suite suitable for public release and community adoption. 🤖 Generated with Claude Code Co-Authored-By: Claude <noreply@anthropic.com>
147 lines
5.4 KiB
Markdown
147 lines
5.4 KiB
Markdown
# Changelog
|
|
|
|
All notable changes to the Tractatus Framework will be documented in this file.
|
|
|
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
|
|
## [3.5.0] - 2025-10-21
|
|
|
|
### Initial Public Release
|
|
|
|
This is the first public release of the Tractatus Framework implementation. The framework provides a complete, production-ready implementation of AI governance services.
|
|
|
|
### Added
|
|
|
|
#### Core Services (6)
|
|
- **InstructionPersistenceClassifier** - Classifies governance instructions by quadrant (STRATEGIC/OPERATIONAL/TACTICAL/SYSTEM/STORAGE) and assigns time-persistence metadata
|
|
- **CrossReferenceValidator** - Validates actions against explicit instructions to prevent cached pattern overrides
|
|
- **BoundaryEnforcer** - Enforces Tractatus architectural boundaries ensuring values decisions require human judgment
|
|
- **ContextPressureMonitor** - Monitors token usage and context pressure, triggering safety protocols at configurable thresholds
|
|
- **MetacognitiveVerifier** - Verifies action reasoning and confidence levels, requiring confirmation for low-confidence actions
|
|
- **PluralisticDeliberationOrchestrator** - Manages multi-stakeholder deliberation processes ensuring value pluralism in decisions
|
|
|
|
#### Support Services (4)
|
|
- **AnthropicMemoryClient** - Integration with Anthropic Memory API for persistent context
|
|
- **MemoryProxy** - Hybrid storage system combining MongoDB with optional Anthropic Memory API
|
|
- **RuleOptimizer** - Rule conflict detection and optimization engine
|
|
- **VariableSubstitution** - Dynamic variable replacement in governance rules
|
|
|
|
#### API Endpoints
|
|
- `/api/governance` - Framework operations (status, classify, validate, enforce, pressure, verify)
|
|
- `/api/rules` - Governance rules CRUD operations and search
|
|
- `/api/projects` - Multi-project configuration management
|
|
- `/api/audit` - System audit trail and statistics
|
|
|
|
#### Database Models (9)
|
|
- Core models: GovernanceRule, Project, SessionState, VariableValue
|
|
- Logging models: AuditLog, GovernanceLog, VerificationLog
|
|
- Deliberation models: DeliberationSession, Precedent
|
|
|
|
#### Testing Infrastructure
|
|
- 8 unit tests covering all core services
|
|
- 9 integration tests for full framework and API endpoints
|
|
- Test helpers and MongoDB test utilities
|
|
- Comprehensive test coverage for critical paths
|
|
|
|
#### Deployment
|
|
- Dockerfile with multi-stage build
|
|
- docker-compose.yml for local development
|
|
- Environment configuration templates
|
|
- Sample governance rules JSON
|
|
- Deployment quickstart guide and troubleshooting
|
|
|
|
#### Documentation
|
|
- Complete API documentation (Projects, Rules, OpenAPI 3.0 spec)
|
|
- Code examples for JavaScript and Python
|
|
- Architecture diagrams (main flow, decision trees)
|
|
- Deployment and troubleshooting guides
|
|
- Contributing guidelines and code of conduct
|
|
|
|
#### Security Features
|
|
- Rate limiting middleware (configurable per endpoint)
|
|
- Input validation and sanitization
|
|
- Security headers (Helmet + custom CSP)
|
|
- Error response sanitization (no stack traces in production)
|
|
- CORS configuration
|
|
|
|
### Technical Highlights
|
|
|
|
- **Express.js** server with comprehensive security middleware
|
|
- **MongoDB + Mongoose** for data persistence
|
|
- **Jest** test framework with helpers and fixtures
|
|
- **Docker** support with multi-stage builds
|
|
- **RESTful API** design following best practices
|
|
- **OpenAPI 3.0** specification for API documentation
|
|
|
|
### What's Included
|
|
|
|
- 96 carefully curated files (82% reduction from initial repository)
|
|
- Production-ready code with no placeholder implementations
|
|
- Comprehensive test suite with real-world scenarios
|
|
- Complete documentation for implementers
|
|
- Docker deployment templates
|
|
- GitHub issue and PR templates
|
|
|
|
### Requirements
|
|
|
|
- Node.js 18+ (20+ recommended)
|
|
- MongoDB 7.0+
|
|
- Docker 20+ (for containerized deployment)
|
|
- 2GB+ RAM recommended
|
|
|
|
### Installation
|
|
|
|
```bash
|
|
# Using Docker (recommended)
|
|
git clone https://github.com/AgenticGovernance/tractatus-framework.git
|
|
cd tractatus-framework/deployment-quickstart
|
|
docker-compose up
|
|
|
|
# Manual installation
|
|
npm install
|
|
cp .env.example .env
|
|
npm start
|
|
```
|
|
|
|
### Links
|
|
|
|
- **Documentation**: https://agenticgovernance.digital
|
|
- **Repository**: https://github.com/AgenticGovernance/tractatus-framework
|
|
- **Issues**: https://github.com/AgenticGovernance/tractatus-framework/issues
|
|
- **Release**: https://github.com/AgenticGovernance/tractatus-framework/releases/tag/v3.5.0
|
|
|
|
---
|
|
|
|
## Release History
|
|
|
|
### [3.5.0] - 2025-10-21
|
|
- Initial public release
|
|
|
|
---
|
|
|
|
## Upgrade Guide
|
|
|
|
### Upgrading from Development Versions
|
|
|
|
If you were using a pre-release or development version of the Tractatus Framework, this v3.5.0 release represents the first stable, production-ready version. We recommend:
|
|
|
|
1. **Fresh Installation**: Start with a clean installation rather than upgrading
|
|
2. **Review Breaking Changes**: The public API is now stable and documented
|
|
3. **Update Dependencies**: Ensure Node.js 18+ and MongoDB 7.0+
|
|
4. **Test Thoroughly**: Run the complete test suite after installation
|
|
5. **Review Documentation**: Check the updated API documentation for any changes
|
|
|
|
### Future Upgrades
|
|
|
|
Future releases will include detailed upgrade instructions in this section.
|
|
|
|
---
|
|
|
|
## Contributing
|
|
|
|
See [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct and the process for submitting pull requests.
|
|
|
|
## License
|
|
|
|
This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
|