wehub-resource-sync
97e91a83f3
Ruff / Ruff (push) Waiting to run
Test / Core Tests (push) Waiting to run
Test / Offline Coverage Tests (Python 3.10) (push) Waiting to run
Test / Offline Coverage Tests (Python 3.11) (push) Waiting to run
Test / Offline Coverage Tests (Python 3.12) (push) Waiting to run
Test / Offline Coverage Tests (Python 3.13) (push) Waiting to run
Test / Offline Coverage Tests (Python 3.9) (push) Waiting to run
Test / Full Coverage (Python 3.11) (push) Waiting to run
Test / Core Provider Tests (OpenAI) (push) Blocked by required conditions
Test / Core Provider Tests (Anthropic) (push) Blocked by required conditions
Test / Core Provider Tests (Google) (push) Blocked by required conditions
Test / Core Provider Tests (Other) (push) Blocked by required conditions
Test / Anthropic Tests (push) Blocked by required conditions
Test / Gemini Tests (push) Blocked by required conditions
Test / Google GenAI Tests (push) Blocked by required conditions
Test / Vertex AI Tests (push) Blocked by required conditions
Test / OpenAI Tests (push) Blocked by required conditions
Test / Writer Tests (push) Blocked by required conditions
Test / Auto Client Tests (push) Blocked by required conditions
ty / type-check (push) Waiting to run
36 lines
1.1 KiB
Plaintext
36 lines
1.1 KiB
Plaintext
---
|
|
description: when making code changes or adding documentation
|
|
globs: ["*.py", "*.md"]
|
|
alwaysApply: true
|
|
---
|
|
|
|
- When making code changes:
|
|
- Update related documentation files to reflect the changes
|
|
- Check docstrings and type hints are up to date
|
|
- Update any example code in markdown files
|
|
- Review README.md if the changes affect installation or usage
|
|
|
|
- When creating new markdown files:
|
|
- Add the file to mkdocs.yml under the appropriate section
|
|
- Follow the existing hierarchy and indentation
|
|
- Use descriptive nav titles
|
|
- Example:
|
|
```yaml
|
|
nav:
|
|
- Home: index.md
|
|
- Guides:
|
|
- Getting Started: guides/getting-started.md
|
|
- Your New File: guides/your-new-file.md
|
|
```
|
|
|
|
- For API documentation:
|
|
- Ensure new functions/classes are documented
|
|
- Include type hints and docstrings
|
|
- Add usage examples
|
|
- Update API reference docs if auto-generated
|
|
|
|
- Documentation Quality:
|
|
- Write at grade 10 reading level (see simple-language.mdc)
|
|
- Include working code examples
|
|
- Add links to related documentation
|
|
- Use consistent formatting and style |