ADR-019: Bash Script Naming Convention with Dashes

Status

Status: Accepted Date: 2025-09-16 Authors: Entirius Team

Decision

All bash script filenames shall use lowercase letters with dashes (kebab-case) as word separators.

Use: my-script.sh, deploy-services.sh, run-dev-server.sh Instead of: myScript.sh, my_script.sh, MyScript.sh Reason: Consistent with web standards and improves readability across different systems.

Quick Reference

# Correct naming examples
./scripts/deploy-application.sh
./scripts/backup-database.sh
./scripts/run-development-server.sh
./devops/setup-environment.sh

# Incorrect naming examples (avoid these)
./scripts/deployApplication.sh
./scripts/backup_database.sh
./scripts/RunDevelopmentServer.sh

Context

The project needs consistent naming conventions for bash scripts to maintain code organization and improve developer experience across different operating systems and environments.

Rationale

Primary benefit: Consistent with existing web standards and Hugo static site naming conventions
Trade-offs: Requires refactoring existing scripts that don’t follow this pattern
Impact: Improves code readability and maintains consistency with project documentation naming

ADR-012: English language requirement applies to script names