feat: formalize headers and

[wambitz]

Description

This pull request resolves #35 and improves the consistency and clarity of all project shell scripts by standardizing the shebang lines, enforcing immediate error exits, and adding detailed documentation headers. These changes make the scripts easier to understand, maintain, and use.

Script standardization and documentation:

• Replaced all #!/bin/bash shebangs with #!/usr/bin/env bash for portability and added set -e to ensure scripts exit on error. [1] [2] [3] [4] [5]
• Added detailed documentation headers to each script, describing their purpose, usage, and relevant environment variables, improving clarity and maintainability. [1] [2] [3] [4] [5] [6] [7] [8] [9]

Script-specific improvements:

• Updated usage instructions and clarified the behavior of scripts such as build.sh, coverage.sh, format.sh, package.sh, lint.sh, and all scripts in scripts/docker/. [1] [2] [3] [4] [5] [6] [7] [8] [9]
• Improved comments and documentation on Docker-related scripts to clarify UID/GID remapping and container interaction. [1] [2] [3]

These changes collectively enhance script reliability, readability, and user experience.

[Copilot]

Pull request overview

This pull request standardizes shell scripts across the project by updating shebangs to #!/usr/bin/env bash, adding set -e for error handling, and providing comprehensive documentation headers. These changes improve portability, reliability, and maintainability of all project scripts.

Key Changes:

• Standardized shebang lines to #!/usr/bin/env bash and added set -e for immediate error exit across all shell scripts
• Added uniform documentation headers with purpose, usage, and environment variable descriptions to all scripts
• Enhanced Docker script documentation to clarify UID/GID remapping behavior and container interaction patterns

Reviewed changes

Copilot reviewed 9 out of 10 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
scripts/package.sh	Added standard header documenting Release mode build and package creation
scripts/lint.sh	Added standard header documenting clang-tidy static analysis usage
scripts/format.sh	Added standard header clarifying in-place and check-only formatting modes
scripts/docs.sh	Added standard header documenting Doxygen documentation generation
scripts/docker/run.sh	Added standard header explaining interactive Docker container execution with UID/GID remapping
scripts/docker/entrypoint.sh	Added comprehensive header documenting UID/GID remapping mechanism and environment variables
scripts/docker/build_image.sh	New file with standard header documenting Docker image build process
scripts/docker/attach.sh	Added standard header documenting attachment to running containers
scripts/coverage.sh	Added standard header documenting coverage build, test execution, and report generation
scripts/build.sh	Added standard header documenting Debug mode build and installation process

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.