Expert assistant for acme-portal-sdk, a deployment management tool for flow-based applications (Jobs/DAGs/Workflows). Enforces clean code principles, DRY, orthogonality, and project-specific documentation standards.
Expert assistant for developing and maintaining acme-portal-sdk, a Python SDK for managing deployments of flow-based applications (Jobs/DAGs/Workflows). Designed to work with the acme-portal VSCode extension.
This skill enforces the following development principles for the acme-portal-sdk codebase:
When writing or updating documentation:
**Style Guidelines:**
**Code Comments:**
1. **Check for Existing Patterns**
- Search the codebase for similar functionality
- Identify reusable components or utilities
- Verify typing patterns used in similar code
2. **Design the Component**
- Identify the single responsibility
- Isolate concerns into separate functions/classes
- Choose clear, descriptive names
- Ensure the design is reversible if requirements change
3. **Implement with DRY in Mind**
- Extract shared logic into reusable functions
- Centralize constants and configuration
- Avoid copy-pasting code blocks
4. **Add Type Annotations**
- Include proper Python type hints for all parameters and return values
- Use `typing` module types where appropriate (List, Dict, Optional, etc.)
- Verify types are accurate and complete
5. **Document Appropriately**
- Add docstrings to public functions and classes
- Document complex logic with inline comments (sparingly)
- Focus on what the code does, not how it changed
- Keep documentation direct and verbose where needed
6. **Review Orthogonality**
- Ensure new functionality doesn't overlap with existing features
- Verify changes are isolated to the relevant component
1. **Identify Code Smells**
- Look for duplicated code blocks
- Find components with multiple responsibilities
- Spot poorly named variables or functions
2. **Apply DRY Principle**
- Extract common logic into shared utilities
- Centralize repeated definitions
- Update all usage sites to reference the centralized version
3. **Improve Component Design**
- Split multi-responsibility components into single-purpose ones
- Isolate distinct concerns
- Make components more reusable
4. **Verify Types and Documentation**
- Update type annotations if signatures changed
- Refresh documentation to match new implementation
- Remove obsolete comments
1. **Check Contributing Guidelines**
- Read `CONTRIBUTING.md` in the repository root
- Verify the code follows all project guidelines
- Ensure coding standards are met
2. **Verify Design Principles**
- Single responsibility maintained?
- Concerns properly isolated?
- Names clear and descriptive?
- DRY principle followed?
3. **Review Types and Docs**
- Type annotations present and correct?
- Documentation updated to match implementation?
- Comments explain complex logic (not obvious code)?
4. **Assess Orthogonality**
- Does new code overlap with existing functionality?
- Are changes properly isolated?
Leave a review
No reviews yet. Be the first to review this skill!
# Download SKILL.md from killerskills.ai/api/skills/acme-portal-sdk-development-assistant/raw