Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,25 @@ Documentation is a critical part of the project. All changes should include appr
- **API Changes**: Update OpenAPI specifications and CLI reference
- **Keep Current**: Remove outdated information and fix broken links

## Code Governance & Quality Assurance

The project maintains high code quality through systematic review processes:

### Codebase Review Process

- **[Full Inventory & Review](docs/tasks/prd-full-inventory-review.md)**: Comprehensive codebase review framework
- **[Review Templates](docs/reviews/)**: Standardized templates for systematic quality assessment
- **Review Scope**: Package-by-package analysis, documentation alignment, security audit
- **Quality Gates**: 90%+ coverage, clean lints, architectural compliance
- **Non-blocking**: Reviews don't halt development; used for continuous improvement

### Quality Standards

- **Architecture Alignment**: Regular verification against `docs/architecture.md`
- **Security Compliance**: Access control, secret scanning, dependency audits
- **Performance Monitoring**: Latency targets, memory efficiency, scalability assessment
- **Documentation Currency**: Alignment between code and documentation

## Testing

Comprehensive testing is mandatory. See the [Testing Guide](docs/testing-guide.md) for detailed information.
Expand Down
24 changes: 24 additions & 0 deletions PLAN.md
Original file line number Diff line number Diff line change
Expand Up @@ -490,3 +490,27 @@ To maximize security and minimize attack surface, the proxy implements a whiteli
- The event bus is now always enabled by default; configuration options have changed.
- For persistent event logging, use the new dispatcher command or the `--file-event-log` flag.
- OpenAI token counting is now accurate and uses tiktoken-go for all prompt/completion calculations.

## Project Governance & Quality Assurance

The project maintains high standards through systematic review and governance processes:

### Code Quality Framework
- **[Full Inventory & Review Process](docs/tasks/prd-full-inventory-review.md)**: Comprehensive codebase review framework for architectural compliance
- **[Review Templates](docs/reviews/)**: Standardized templates for systematic quality assessment
- **Quality Gates**: 90%+ coverage (enforced), clean lints, architectural alignment verification
- **Test-Driven Development**: Mandatory TDD with failing tests before implementation

### Governance Integration
- **Architecture Compliance**: Regular verification against documented design principles
- **Security Review**: Systematic assessment of access controls, secrets management, and dependency security
- **Documentation Alignment**: Continuous validation of code-documentation consistency
- **Non-blocking Process**: Reviews guide improvement without halting development

### Review Scope
- **Package-by-Package Analysis**: Systematic review of all `internal/*` and `cmd/*` components
- **Dead Code Detection**: Identification and removal of unused code and dependencies
- **Performance Assessment**: Latency, memory efficiency, and scalability compliance
- **Maintainer Sign-off**: Governance oversight with clear accountability and follow-up tracking

This governance framework ensures architectural integrity, security compliance, and code quality while maintaining development velocity and transparency.
5 changes: 5 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,11 @@ The [OpenAPI specification](../api/openapi.yaml) provides machine-readable API d
- **[Code Organization Guide](code-organization.md)** - Package structure, layering, and architectural boundaries
- **[Development Setup](copilot-agent-setup.md)** - Development environment and tooling

## Governance & Quality Assurance

- **[Full Codebase Inventory & Review](tasks/prd-full-inventory-review.md)** - Comprehensive codebase review process and templates
- **[Review Templates](reviews/)** - Templates for conducting systematic code reviews and quality assessments

## Implementation Details

- **[Issues](issues/)** - Design decisions, architectural discussions, and implementation notes
Expand Down
18 changes: 18 additions & 0 deletions docs/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -661,6 +661,24 @@ graph TD
- **Distributed Rate Limiting**: Redis-backed rate limiting for clustered deployments
- **Real-time Usage Metrics**: Streaming metrics via WebSockets for monitoring dashboards

## Code Governance & Architecture Compliance

The project maintains architectural integrity through systematic review processes:

### Architectural Review Framework

- **[Full Inventory & Review Process](tasks/prd-full-inventory-review.md)**: Comprehensive framework for architecture compliance verification
- **[Review Templates](reviews/)**: Standardized templates for systematic architectural assessment
- **Architecture Drift Detection**: Regular verification of implementation against this document
- **Component Boundary Enforcement**: Package-level isolation and interface compliance review

### Quality Gates for Architecture

- **Design Principle Compliance**: Verification of minimal transformation, transparency, and performance principles
- **Component Interaction Validation**: Review of data flow and component boundaries
- **Interface Consistency**: API design and package interface alignment verification
- **Performance Characteristic Maintenance**: Latency, memory, and scalability goal compliance

## Whitelist (Allowlist) for URIs and Methods

To ensure security and maintain transparency, the proxy uses a whitelist (allowlist) for valid API URIs and HTTP methods. For the MVP, this list is hardcoded for OpenAI endpoints (such as `/v1/chat/completions`, `/v1/completions`, `/v1/embeddings`, `/v1/models`) and methods (`POST`, `GET`).
Expand Down
Loading