dpla-script-workflow

Enforce POSIX bash compatibility and common.sh usage for shell and Python scripts.

35|12|Updated Jan 10, 2017
One-click install
npx skills add https://github.com/dpla/ingestion3 --skill dpla-script-workflow
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: dpla-script-workflow
Source: https://github.com/dpla/ingestion3/tree/main/.cursor/skills/dpla-script-workflow
Command: npx skills add https://github.com/dpla/ingestion3 --skill dpla-script-workflow

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill helps teams enforce a consistent, documented workflow for adding or updating shell and Python scripts in the codebase, reducing drift and errors.

Core Features & Use Cases

  • Enforces POSIX-compliant script conventions and the use of project utilities (e.g., common.sh) for scripting tasks.
  • Guides users on when to create, modify, or review scripts to align with repository standards.
  • Use Case: A developer wants to add a new script and must follow the project workflow to ensure tests, docs, and references are updated.

Quick Start

Follow the project script workflow when adding or modifying a script to ensure POSIX bash compatibility, documentation, and tests are updated.

Frequently Asked Questions about dpla-script-workflow

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

FAQPage Schema
How do I ensure my bash scripts are POSIX compliant when adding them to a repository?

To ensure POSIX bash compliance when adding scripts, follow a project workflow that validates shell syntax against POSIX standards. This process automatically checks your scripts for portability and enforces the use of repository conventions like common.sh helpers.

What is the standard workflow for updating shell and Python scripts in a codebase?

The standard workflow for updating shell and Python scripts involves validating repository convention compliance, ensuring POSIX bash compatibility, and updating associated documentation and tests. This maintains codebase consistency and reduces drift when modifications occur.

Do I need to update tests and documentation when modifying an existing shell script?

Yes, you need to update tests and documentation when modifying an existing shell script. The script workflow mandates that any changes to shell or Python scripts trigger the creation or update of relevant tests and docs to maintain compliance.

How do I use common.sh helpers in my bash scripts?

To use common.sh helpers in your bash scripts, apply the project script workflow during script creation or modification. The workflow guides developers to integrate these project utilities to ensure scripts align with repository standards.

What is the best way to enforce shell script conventions across a development team?

The best way to enforce shell script conventions is to automate adherence to a documented project workflow. This ensures every new or modified script passes POSIX bash compatibility checks and utilizes common.sh helpers, reducing errors and convention drift.

Can I validate Python script changes against repository conventions?

Yes, you can validate Python script changes against repository conventions. The script workflow applies to both shell and Python scripts, ensuring that updates trigger necessary documentation and test creation to maintain full repository compliance.