Agent-Skills.md

Agent Skills: Review code and analysis scripts

Review a script for documentation quality, code standards, and reproducibility. Helps ensure code is ready for the methods section. Use when the user types /review_script, after writing a new script, before writing methods, or when passive checks flag undocumented scripts.

UncategorizedID: braselog/researchassistant/review-script

Repository

braselog/researchassistant
braselog
2

Install this agent skill to your local

pnpm dlx add-skill https://github.com/braselog/researchAssistant/tree/HEAD/.github/skills/review-script

Skill Files

Browse the full folder contents for review-script.

Download Skill

Loading file tree…

.github/skills/review-script/SKILL.md

Skill Metadata

Name
review-script
Description
Reviews code for behavioural correctness, failure handling, reproducibility, testing, and scientific validity. Use for /review_script, code review, or before relying on a script in an analysis or methods section.

Review code and analysis scripts

Read the target code, callers, configuration, tests, pipeline definition, and relevant scientific context.

Review order

  1. Intended behaviour and data contract
  2. Correctness on realistic and edge-case inputs
  3. Experimental-unit, leakage, alignment, coordinate, and parameter-propagation risks
  4. Errors, silent fallbacks, skipped work, and partial outputs
  5. Reproducibility: paths, seeds, dependencies, provenance, DVC inputs/outputs
  6. Tests, observability, maintainability, and documentation

Verify important claims by running focused tests or small fixtures when safe. Do not equate style with correctness or require docstrings for trivial private helpers. Report findings by severity with file/line evidence, impact, and a concrete fix. Distinguish observed defects from questions and optional improvements. Do not modify files unless asked.