Script Best Practices

What it does

This skill provides guidance and recommendations for writing clean, efficient, and maintainable scripts. It helps users avoid common pitfalls in scripting languages like Python or Bash by suggesting best practices for variable naming, code formatting, error handling, and more. The goal is to improve script readability and reduce debugging time.

When to use it

• When starting a new scripting project to establish good coding habits from the beginning.
• When refactoring existing scripts that are difficult to understand or maintain.
• To review code written by others, ensuring adherence to established standards.
• For automated tasks where reliability and consistency are crucial.

Key capabilities

• Code formatting suggestions
• Variable naming conventions
• Error handling best practices
• Script structure recommendations
• Comments and documentation guidelines

Example prompts

• "Review this Python script for style and efficiency." (followed by the script content)
• "What are some best practices for variable naming in Bash?"
• "Suggest improvements to this script's error handling." (followed by the script content)

Tips & gotchas

This skill assumes a basic understanding of scripting concepts. While it can identify issues, it won’t automatically fix them; users need to understand the suggestions and apply them appropriately.