Add Performance as a changelog fragment option
This commit is contained in:
@@ -25,7 +25,7 @@ uv run pytest tests/test_name.py
|
|||||||
uv run pytest tests/test_name.py::test_function_name
|
uv run pytest tests/test_name.py::test_function_name
|
||||||
|
|
||||||
# Preview changelog
|
# Preview changelog
|
||||||
towncrier build --draft --version Unreleased
|
uv run towncrier build --draft --version Unreleased
|
||||||
|
|
||||||
# Lint and format check
|
# Lint and format check
|
||||||
uv run ruff check
|
uv run ruff check
|
||||||
@@ -91,7 +91,7 @@ All data flows as **Frame** objects through a pipeline of **FrameProcessors**:
|
|||||||
### Key Directories
|
### Key Directories
|
||||||
|
|
||||||
| Directory | Purpose |
|
| Directory | Purpose |
|
||||||
|---------------------------|----------------------------------------------------|
|
| -------------------------- | -------------------------------------------------- |
|
||||||
| `src/pipecat/frames/` | Frame definitions (100+ types) |
|
| `src/pipecat/frames/` | Frame definitions (100+ types) |
|
||||||
| `src/pipecat/processors/` | FrameProcessor base + aggregators, filters, audio |
|
| `src/pipecat/processors/` | FrameProcessor base + aggregators, filters, audio |
|
||||||
| `src/pipecat/pipeline/` | Pipeline orchestration |
|
| `src/pipecat/pipeline/` | Pipeline orchestration |
|
||||||
@@ -155,4 +155,3 @@ When adding a new service:
|
|||||||
## Testing
|
## 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.
|
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.
|
||||||
|
|
||||||
|
|||||||
@@ -49,12 +49,12 @@ Every pull request that makes a user-facing change should include a changelog en
|
|||||||
```
|
```
|
||||||
|
|
||||||
2. Choose the appropriate type:
|
2. Choose the appropriate type:
|
||||||
|
|
||||||
- `added.md` - New features
|
- `added.md` - New features
|
||||||
- `changed.md` - Changes in existing functionality
|
- `changed.md` - Changes in existing functionality
|
||||||
- `deprecated.md` - Soon-to-be removed features
|
- `deprecated.md` - Soon-to-be removed features
|
||||||
- `removed.md` - Removed features
|
- `removed.md` - Removed features
|
||||||
- `fixed.md` - Bug fixes
|
- `fixed.md` - Bug fixes
|
||||||
|
- `performance.md` - Performance improvements
|
||||||
- `security.md` - Security fixes
|
- `security.md` - Security fixes
|
||||||
- `other.md` - Other changes (documentation, dependencies, etc.)
|
- `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
|
```markdown
|
||||||
- Updated service configuration:
|
- Updated service configuration:
|
||||||
|
|
||||||
- Changed default timeout to 30 seconds
|
- Changed default timeout to 30 seconds
|
||||||
- Added retry logic for failed connections
|
- Added retry logic for failed connections
|
||||||
```
|
```
|
||||||
@@ -105,7 +104,6 @@ changelog/1234.changed.2.md
|
|||||||
|
|
||||||
```markdown
|
```markdown
|
||||||
- Updated service configuration:
|
- Updated service configuration:
|
||||||
|
|
||||||
- Changed default timeout to 30 seconds
|
- Changed default timeout to 30 seconds
|
||||||
- Added retry logic for failed connections
|
- Added retry logic for failed connections
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -257,6 +257,11 @@ directory = "fixed"
|
|||||||
name = "Fixed"
|
name = "Fixed"
|
||||||
showcontent = true
|
showcontent = true
|
||||||
|
|
||||||
|
[[tool.towncrier.type]]
|
||||||
|
directory = "performance"
|
||||||
|
name = "Performance"
|
||||||
|
showcontent = true
|
||||||
|
|
||||||
[[tool.towncrier.type]]
|
[[tool.towncrier.type]]
|
||||||
directory = "security"
|
directory = "security"
|
||||||
name = "Security"
|
name = "Security"
|
||||||
|
|||||||
Reference in New Issue
Block a user