review-script

Community

Guarantee script quality: docs and reproducibility.

Authorbraselog
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill helps ensure code scripts are well-documented, adhere to standards, and are reproducible, enabling smoother method sections and repeatable analyses.

Core Features & Use Cases

  • Documentation Audit: Review module and function docstrings, inline comments, and usage examples.
  • Code Quality & Reproducibility: Check for seeds, configurable parameters, and dependency integrity.
  • Use Case: Before adding a new preprocessing script to a project, run this Skill to verify documentation and reproducibility readiness.

Quick Start

Use this Skill after creating or updating a script to generate a comprehensive documentation and quality report, e.g., /review_script scripts/preprocess.py or /review_script scripts/

Dependency Matrix

Required Modules

None required

Components

scripts

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: review-script
Download link: https://github.com/braselog/researchAssistant/archive/main.zip#review-script

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.