Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 69 additions & 0 deletions .claude/skills/docstring/SKILL.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
---
name: docstring
description: Generate Google-style docstrings for Python classes and functions
---

Add or update docstrings for Python code. This skill follows Google-style docstrings compatible with pdoc3.

**Note:** For pdoc3 to properly render Google-style docstrings, ensure the module includes `__docformat__ = "google"` at the top, or run pdoc with `--docformat google`.

## Usage

```bash
/docstring ClassName
/docstring path/to/file.py
```

## Instructions

1. Find the target class or function
2. If multiple matches exist, ask for clarification
3. Skip already-documented code unless explicitly asked to update
4. Generate comprehensive docstrings

## Format

```python
def function_name(arg1: str, arg2: int = 0) -> bool:
"""Short one-line description.

Longer description if needed, explaining the purpose
and any important behavior.

Args:
arg1: Description of arg1.
arg2: Description of arg2. Defaults to 0.

Returns:
Description of return value.

Raises:
ValueError: When arg1 is empty.

Example:
>>> function_name("hello", 42)
True
"""
```

## Class Docstrings

```python
class MyClass:
"""Short description of the class.

Longer description explaining the purpose and usage.

Attributes:
attr1: Description of attr1.
attr2: Description of attr2.
"""
```

## Guidelines

- Keep the first line under 80 characters
- Use imperative mood ("Return" not "Returns")
- Document all public methods and attributes
- Include type hints in signatures, not docstrings
- Add Examples section for complex functionality
47 changes: 47 additions & 0 deletions .claude/skills/pr-description/SKILL.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
name: pr-description
description: Generate or update PR descriptions following LiveKit conventions
---

Create a pull request description for this branch. If updating, preserve key information.

## Format

```markdown
## Summary

- Clear, bullet-point overview of changes
- Focus on the _why_, not just the _what_

## Changes

- List specific files/modules affected
- Note any breaking changes with ⚠️ prefix

## Testing

- How was this tested?
- Include commands or steps if applicable

## Related

- Fixes #XXX (if applicable)
```

## Guidelines

- **Be concise** - Reviewers should understand in 30 seconds
- **Use bullet points** - Easier to scan
- **Don't duplicate the diff** - Explain intent, not implementation
- Follow [CONTRIBUTING.md](/CONTRIBUTING.md) guidelines
- **For Python changes:** Run `ruff check --fix` and `ruff format` before finalizing

## Checklist

Before updating the PR:

- [ ] Verified existing description needs updating (not already complete)
- [ ] Summary accurately reflects the changes
- [ ] Breaking changes are clearly documented (if any)
- [ ] No unnecessary sections included
- [ ] Description is concise and scannable