Specvital 문서
Specvital은 코드 리뷰 프로세스를 개선하기 위해 설계된 오픈소스 테스트 커버리지 인사이트 도구.
문서 구조
PRD (Product Requirements Document)
Specvital 플랫폼의 제품 사양 및 요구사항 문서.
- 제품 개요 - 제품 비전, 타겟 사용자, GTM 전략
- 아키텍처 - 시스템 아키텍처 및 서비스 구성
- 코어 엔진 - 테스트 파서 라이브러리 설계
- 웹 플랫폼 - 웹 대시보드 및 REST API
- 컬렉터 서비스 - 백그라운드 분석 워커
- 데이터베이스 설계 - 데이터베이스 스키마 및 설계
- 기술 스택 - 기술 선택 및 근거
ADR (Architecture Decision Records)
Specvital 개발 중 내린 아키텍처 결정에 대한 문서.
공통
- ADR 개요 - 아키텍처 결정 기록 소개
- 정적 분석 접근법
- 경쟁 차별화
- API 워커 서비스 분리
- 큐 기반 비동기 처리
- 리포지토리 전략
- PaaS 우선 인프라
- 공유 인프라
- External Repo ID 무결성
- GitHub App 통합
- TestStatus 데이터 계약
- 코어 라이브러리 분리
- 동적 테스트 카운팅 정책
- Tree-sitter AST 파싱 엔진
- Early-Return 프레임워크 탐지
- 파서 풀링 비활성화
- 통합 Framework Definition
- Source 추상화 인터페이스
- 공유 파서 모듈
- Config 스코프 해석
- 표준 Go 프로젝트 레이아웃
- 골든 스냅샷 통합 테스트
- Worker Pool 병렬 스캔
- NaCl SecretBox 암호화
- 간접 Import Alias 감지 미지원
- 스케줄 기반 재수집
- Clean Architecture 레이어
- Graceful Shutdown
- OAuth 토큰 Degradation
- Worker-Scheduler 분리
- Semaphore Clone 동시성
- Repository 패턴
기술 레이더
플랫폼 전반의 기술 채택 현황 및 평가 기준.
릴리즈 노트
전체 서비스 릴리즈 히스토리 (Core, Collector, Web, Infra).
용어집
플랫폼 전반에서 사용되는 도메인 용어.
아키텍처 개요
상위 수준의 시스템 아키텍처 문서.
관련 리포지토리
Specvital 플랫폼은 여러 리포지토리로 구성됨:
- specvital/core - 파서 엔진
- specvital/web - 웹 플랫폼
- specvital/collector - 워커 서비스
- specvital/infra - 인프라 및 스키마
기여하기
Specvital의 메인 문서 리포지토리. 기여 가이드라인은 각 리포지토리의 CONTRIBUTING.md 파일 참조.
라이선스
자세한 내용은 LICENSE 참조.