Skip to content

Delivery Standards and Quality Control

This document defines minimum delivery standards for partner work using ConnectSoft Factory and platforms. It is written for partners delivering solutions and ConnectSoft team members reviewing partner work.

Quality standards ensure consistent, high-quality delivery across all partner projects. Partners must meet these standards to maintain certification and deliver successful projects.

Important

Non-Negotiables: 1. All code must follow Clean Architecture and DDD patterns 2. All services must include observability (logging, tracing, metrics) 3. All code must have tests (minimum 80% coverage for domain logic) 4. All services must include CI/CD pipelines 5. All documentation must follow ConnectSoft style guide

Coding and Architecture Standards

Architecture Patterns

Required Patterns: - Clean Architecture - Domain → Application → Infrastructure layers - DDD - Bounded contexts, aggregates, domain events - Event-Driven - Important actions expressed as events - Cloud-Native - Stateless, scalable, observable

See: Clean Architecture & DDD for architecture principles.

See: Microservice Template for template structure.

See: Agent Microservice Standard Blueprint for standard blueprint.

Code Quality Standards

Required: - [ ] Follow C# coding conventions - [ ] Use async/await for I/O operations - [ ] Include XML documentation - [ ] Use dependency injection - [ ] Include observability hooks

Code Review Checklist: - [ ] Clean Architecture compliance - [ ] DDD patterns applied - [ ] Event-driven patterns used - [ ] Observability included - [ ] Security patterns implemented

Testing and CI/CD Requirements

Testing Requirements

Minimum Requirements: - Unit Tests - Minimum 80% coverage for domain logic - Integration Tests - Critical paths have integration tests - BDD Specs - Acceptance criteria covered by BDD specs - Test Quality - Tests are meaningful and maintainable

Test Structure: - Unit tests for domain logic - Integration tests for application layer - API tests for API endpoints - End-to-end tests for critical flows

See: Testing Strategy for testing guidance.

CI/CD Requirements

Pipeline Requirements: - [ ] Build stage (compile, restore packages) - [ ] Test stage (unit, integration tests) - [ ] Quality gates (code coverage, static analysis) - [ ] Deploy stage (dev, staging, production) - [ ] Observability validation

Pipeline Standards: - All tests must pass - Code coverage thresholds met - Security scanning completed - Deployment to dev environment successful

See: CI/CD Guidelines for pipeline guidance.

Documentation Requirements

Code Documentation

Required: - XML documentation for public APIs - README files for services - Architecture documentation (ADR format) - API documentation (OpenAPI/Swagger)

See: Contributing Documentation for documentation guidelines.

Project Documentation

Required: - Project overview and architecture - Setup and deployment instructions - API documentation - Integration guides

See: Documentation Style Guide for documentation style.

Review and Approval Process

Review Stages

Stage 1: Architecture Review - Bounded context design - Service boundaries - Integration patterns - Technology choices

Stage 2: Code Review - Code quality and patterns - Test coverage and quality - Observability implementation - Security patterns

Stage 3: Integration Review - Platform integration - External system integration - Event flows - API contracts

Stage 4: Deployment Review - CI/CD pipeline - Deployment configuration - Environment setup - Monitoring and alerting

Approval Requirements

ConnectSoft Must Approve: - Final architecture (before implementation) - Production deployment (before go-live) - Breaking changes (before implementation) - Security changes (security review required)

Partner Can Approve: - Development work (within approved architecture) - Test implementation - Documentation updates - Non-breaking changes

Escalation and Remediation

Quality Issues

Issue Types: - Architecture violations - Code quality issues - Test coverage gaps - Documentation gaps

Remediation Process: 1. Issue identified during review 2. Partner notified with details 3. Remediation plan agreed 4. Partner fixes issues 5. Re-review and approval

Escalation Path

Escalation Triggers: - Repeated quality issues - Critical architecture violations - Security concerns - Customer complaints

Escalation Process: 1. Issue escalated to ConnectSoft partner manager 2. Review and assessment 3. Remediation plan or partner action 4. Follow-up and monitoring