diff --git a/CLAUDE.md b/CLAUDE.md index 6886fc1ed..7727975b3 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -25,7 +25,7 @@ uv run pytest tests/test_name.py uv run pytest tests/test_name.py::test_function_name # Preview changelog -towncrier build --draft --version Unreleased +uv run towncrier build --draft --version Unreleased # Lint and format check uv run ruff check @@ -74,7 +74,7 @@ All data flows as **Frame** objects through a pipeline of **FrameProcessors**: - **Context Aggregation**: `LLMContext` accumulates messages for LLM calls; `UserResponse` aggregates user input - **Turn Management**: Turn management is done through `LLMUserAggregator` and -`LLMAssistantAggregator`, created with `LLMContextAggregatorPair` + `LLMAssistantAggregator`, created with `LLMContextAggregatorPair` - **User turn strategies**: Detection of when the user starts and stops speaking is done via user turn start/stop strategies. They push `UserStartedSpeakingFrame` and `UserStoppedSpeakingFrame` respectively. @@ -90,17 +90,17 @@ All data flows as **Frame** objects through a pipeline of **FrameProcessors**: ### Key Directories -| Directory | Purpose | -|---------------------------|----------------------------------------------------| -| `src/pipecat/frames/` | Frame definitions (100+ types) | -| `src/pipecat/processors/` | FrameProcessor base + aggregators, filters, audio | -| `src/pipecat/pipeline/` | Pipeline orchestration | -| `src/pipecat/services/` | AI service integrations (60+ providers) | -| `src/pipecat/transports/` | Transport layer (Daily, LiveKit, WebSocket, Local) | -| `src/pipecat/serializers/`| Frame serialization for WebSocket protocols | -| `src/pipecat/observers/` | Pipeline observers for monitoring frame flow | -| `src/pipecat/audio/` | VAD, filters, mixers, turn detection, DTMF | -| `src/pipecat/turns/` | User turn management | +| Directory | Purpose | +| -------------------------- | -------------------------------------------------- | +| `src/pipecat/frames/` | Frame definitions (100+ types) | +| `src/pipecat/processors/` | FrameProcessor base + aggregators, filters, audio | +| `src/pipecat/pipeline/` | Pipeline orchestration | +| `src/pipecat/services/` | AI service integrations (60+ providers) | +| `src/pipecat/transports/` | Transport layer (Daily, LiveKit, WebSocket, Local) | +| `src/pipecat/serializers/` | Frame serialization for WebSocket protocols | +| `src/pipecat/observers/` | Pipeline observers for monitoring frame flow | +| `src/pipecat/audio/` | VAD, filters, mixers, turn detection, DTMF | +| `src/pipecat/turns/` | User turn management | ## Code Style @@ -155,4 +155,3 @@ When adding a new service: ## Testing Test utilities live in `src/pipecat/tests/utils.py`. Use `run_test()` to send frames through a pipeline and assert expected output frames in each direction. Use `SleepFrame(sleep=N)` to add delays between frames. - diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 937532ec9..936a652fa 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -49,12 +49,12 @@ Every pull request that makes a user-facing change should include a changelog en ``` 2. Choose the appropriate type: - - `added.md` - New features - `changed.md` - Changes in existing functionality - `deprecated.md` - Soon-to-be removed features - `removed.md` - Removed features - `fixed.md` - Bug fixes + - `performance.md` - Performance improvements - `security.md` - Security fixes - `other.md` - Other changes (documentation, dependencies, etc.) @@ -80,7 +80,6 @@ Every pull request that makes a user-facing change should include a changelog en ```markdown - Updated service configuration: - - Changed default timeout to 30 seconds - Added retry logic for failed connections ``` @@ -105,7 +104,6 @@ changelog/1234.changed.2.md ```markdown - Updated service configuration: - - Changed default timeout to 30 seconds - Added retry logic for failed connections ``` diff --git a/pyproject.toml b/pyproject.toml index a45ebb3b3..d988fa5cd 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -257,6 +257,11 @@ directory = "fixed" name = "Fixed" showcontent = true +[[tool.towncrier.type]] +directory = "performance" +name = "Performance" +showcontent = true + [[tool.towncrier.type]] directory = "security" name = "Security"