mirror of
https://github.com/jxxghp/MoviePilot.git
synced 2026-08-29 12:06:51 +08:00
jxxghp
7e851dbfa7
- ChainBase 拆分为 RecognitionMixin/MessageProcessingMixin/NotificationMixin - TransferChain 拆分为 7 个功能 mixin（_mixins.py），SubscribeChain 音乐订阅域拆出 _music.py - 斜杠命令交互四件套收敛为 InteractionChainMixin 委托，会话管理器移至 application 层，chain 层不再 re-export - 模块基础类收敛到 app/modules/_base（notification/mediaserver 语义重命名） - 清理 app/chain/__init__.py 24 个未使用导入，修正 49 处测试 patch 目标到实际命名空间 - 兼容层 legacy 符号不再并入 __all__，根治 schemas 初始化反向拉起 application.transfer 的循环导入 - 修复 bangumi 集数为字符串时 set_bangumi_info 抛 TypeError - 新增重复代码等架构门禁测试；capability 清单校验排除下划线内部目录
Documentation Hub
This repository maintains a structured documentation library covering the full development lifecycle. All rule documents live in the docs/rules/ directory. This index maps each file to its technical domain and intended reader.
Technical Document Index
Section I: Foundation and Environment
-
01 Project Overview
- File:
01-project-overview.md - Scope: System goals, business domain, deployment models, and what is and is not in this repository.
- File:
-
02 Tech Stack
- File:
02-tech-stack.md - Scope: Frameworks, languages, libraries, runtime environments, and third-party integrations.
- File:
-
03 Commands
- File:
03-commands.md - Scope: CLI reference, development triggers, testing commands, linting, and dependency management.
- File:
Section II: Architecture and Logic
-
04 Design Patterns
- File:
04-design-patterns.md - Scope: Project-specific structural, creational, and behavioral patterns: Module, Chain, Event, Oper, Config Reload, Singleton.
- File:
-
05 Architecture and Modules
- File:
05-architecture.md - Scope: Layer boundaries, dependency directions, module categories, and the canonical call graph.
- File:
-
09 External APIs, Protocols, and Responses
- File:
09-external-response.md - Scope: HTTP client conventions, MCP protocol, standardized response formats, and error handling by layer.
- File:
-
10 Data and Persistent Management
- File:
10-data-and-persistent.md - Scope: SQLAlchemy models, Alembic migrations, Oper access layer, SystemConfig, caching patterns.
- File:
Section III: Implementation Standards
-
06 Code Standards and Style
- File:
06-code-styles.md - Scope: Type annotations, Pydantic usage, async patterns, imports, formatting, and error handling rules.
- File:
-
07 Naming Conventions
- File:
07-naming-conventions.md - Scope: Strict taxonomy for files, classes, functions, constants, and schema models.
- File:
-
08 Comments and Documentation Style
- File:
08-comment-styles.md - Scope: Chinese docstring requirements, inline comment rules, and prohibited comment anti-patterns.
- File:
Section IV: Quality and Governance
-
11 Code Quality and Security
- File:
11-quality-and-security.md - Scope: Testing requirements, pylint gates, safety scans, authentication patterns, and input validation rules.
- File:
-
12 Collaboration, Versioning, Build, and Release
- File:
12-collaboration-and-distribution.md - Scope: Conventional Commits, branch policy, release workflow, Docker build, and version management.
- File:
Reader Persona Guidance
Core Developers and Implementers
Developers actively writing or modifying features should follow this reading path:
- 07 Naming Conventions — establishes the lexicon for the feature.
- 06 Code Standards — ensures linting and logic compliance.
- 04 Design Patterns — identifies the correct structural approach.
- 03 Commands — required for local execution and validation.
System Architects and Reviewers
Personnel focused on system integrity and long-term maintenance:
- 05 Architecture and Modules — for verifying structural boundaries.
- 10 Data and Persistent Management — for auditing data integrity and storage efficiency.
- 09 External APIs — for reviewing integration security and protocol compliance.
- 11 Code Quality and Security — for establishing the PR approval baseline.
Operations and Release Engineers
Those managing the application lifecycle post-development:
- 12 Collaboration and Versioning — for release tags and branch management.
- 02 Tech Stack — for environment provisioning and dependency management.
- 11 Code Quality and Security — for verifying deployment-ready security posture.
Document Interconnectivity
- Architecture (05) references Code Standards (06) for layer isolation and module boundary rules.
- Naming Conventions (07) works in tandem with Comment Styles (08) to define overall code readability.
- External APIs (09) relies on Tech Stack (02) for transport layer specifications and HTTP client selection.
- Data Management (10) is governed by Quality and Security (11) for sensitive data handling requirements.
- Design Patterns (04) is the implementation reference for decisions documented in Architecture (05).
Last Updated: 2026-05-25