cleanup

Standardize code quality and refactoring patterns for HoloViz Python libraries.

3|Updated May 31, 2023

Search Tags:#code quality #code review #best practices #refactoring #python #holoviz

Ready to run

npx skills add https://github.com/Subaru-PFS/spt_etc_webapp --skill cleanup-subaru-pfs

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: cleanup
Source: https://github.com/Subaru-PFS/spt_etc_webapp/tree/main/.claude/skills/contributing-to-holoviz/skills/cleanup
Command: npx skills add https://github.com/Subaru-PFS/spt_etc_webapp --skill cleanup-subaru-pfs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill addresses technical debt and inconsistent coding patterns in HoloViz projects by providing a standardized framework for code reviews and refactoring.

Core Features & Use Cases

Code Review Guidelines: Provides best practices for PR reviews, including rationale-based feedback and architectural consistency.
Style Enforcement: Offers clear rules for imports, class structures, and parameter documentation to ensure maintainable code.
Use Case: When reviewing a pull request for a HoloViz package, use this Skill to verify that the code follows the established patterns for parameter documentation, early returns, and efficient list processing.

Quick Start

Use the cleanup skill to audit the current pull request for adherence to HoloViz coding standards and best practices.

Frequently Asked Questions about cleanup

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I enforce consistent coding standards when reviewing a HoloViz pull request?▼

To enforce consistent coding standards during a HoloViz pull request, apply systematic code review guidelines that verify parameter documentation, import management, and control flow optimization to reduce technical debt.

What is the best way to refactor Python code in HoloViz visualization libraries?▼

The best way to refactor Python code in HoloViz visualization libraries is to apply established patterns for class structures, early returns, and efficient list processing to ensure long-term maintainability.

Does this code review skill support automated import management for Python projects?▼

Yes, this code review skill supports Python projects by enforcing clear rules for import management, class structures, and parameter documentation to maintain architectural consistency across libraries.

How do I reduce technical debt in HoloViz software development?▼

To reduce technical debt in HoloViz software development, use a standardized refactoring framework that provides rationale-based feedback and enforces consistent parameter documentation across the codebase.

Can I use this refactoring framework to optimize control flow in Python visualization libraries?▼

Yes, you can use this refactoring framework to optimize control flow in Python visualization libraries by enforcing early returns and efficient list processing patterns during code reviews.

What are the limitations of using standard code quality patterns for HoloViz projects?▼

This standard code quality framework is specifically tailored for HoloViz projects, meaning its parameter documentation and architectural consistency rules may not directly translate to non-Python visualization environments.