wx44wx/pipecat
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update CLAUDE.md with PR workflow instructions

Browse Source
This commit is contained in:
Aleix Conchillo Flaqué
2026-02-06 15:12:53 -08:00
parent 4945cfbd8f
commit 57df03aade
1 changed files with 8 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
CLAUDE.md
View File

@@ -27,6 +27,10 @@ uv run pytest tests/test_name.py::test_function_name
# Preview changelog # Preview changelog
towncrier build --draft --version Unreleased towncrier build --draft --version Unreleased
# Lint and format check
uv run ruff check
uv run ruff format --check
# Update dependencies (after editing pyproject.toml) # Update dependencies (after editing pyproject.toml)
uv lock && uv sync uv lock && uv sync
``` ```
@@ -122,24 +126,6 @@ class MyService(LLMService):
super().__init__(**kwargs) super().__init__(**kwargs)
``` ```
## Changelog
Every user-facing PR needs a changelog fragment in `changelog/`:
```
changelog/<PR_number>.<type>.md
```
Types: `added`, `changed`, `deprecated`, `removed`, `fixed`, `security`, `other`
Content format (include the `-`):
```markdown
- Added support for new feature X.
```
Skip changelog for: documentation-only, internal refactoring, test-only, CI changes.
## Service Implementation ## Service Implementation
When adding a new service: When adding a new service:
@@ -151,3 +137,7 @@ When adding a new service:
5. Push `ErrorFrame` on failures 5. Push `ErrorFrame` on failures
6. Add metrics tracking via `MetricsData` if relevant 6. Add metrics tracking via `MetricsData` if relevant
7. Follow the pattern of existing services in `src/pipecat/services/` 7. Follow the pattern of existing services in `src/pipecat/services/`
## Pull Requests
After creating a PR, use `/changelog <pr_number>` to generate the changelog file and `/pr-description <pr_number>` to update the PR description.