Skip to content

Quality Assurance and Compliance

This repository enforces code quality, prose hygiene, and legal compliance through a suite of vendored, self-contained Python scripts and static checks. The check_file_ceiling.py script ensures no single hand-authored code file exceeds 1,000 lines, preventing architectural sprawl 1. The check_prose_hygiene.py gate scans tracked text files to ban AI-generated prose tells, such as em/en-dashes, decorative emoji, and stock AI-speak phrases, ensuring documentation remains professional and human-authored 2. These gates are validated by test_prose_hygiene.py to prevent regressions in CI 3. Finally, legal compliance is maintained through the DISCLAIMER.md and LICENSE files, which explicitly state the project is unofficial, unsupported, and not affiliated with Dell, while providing standard MIT licensing terms 4 5.

The script calculates lines using n_lines = text.count("\n") + 1 and fails if any code file exceeds 1,000 lines 1. It excludes binary files, generated lockfiles (e.g., package-lock.json, go.sum), and common build/cache directories (e.g., node_modules, __pycache__). If a file exceeds the limit, the script exits non-zero and prints the offenders sorted by line count, worst-first.

diagram

To maintain high-quality documentation and comments, tools/check_prose_hygiene.py scans tracked text files for AI-generated prose indicators 2. The script identifies three categories of violations: em/en-dashes, decorative emoji, and stock AI-speak phrases.

diagram

The tests/test_prose_hygiene.py script serves as the test runner for the prose hygiene gate 3. It ensures that the vendored tools/check_prose_hygiene.py script exists and runs successfully against the repository root. This test is designed to fail if any tracked text file contains banned AI-generated prose tells, thereby blocking regressions in CI or pre-push hooks.

diagram

Legal compliance is enforced through static files DISCLAIMER.md and LICENSE 4 5. The DISCLAIMER.md file explicitly states that the project is unofficial, experimental, and unsupported, with no warranty of any kind 4. It also clarifies that the project is not affiliated with or endorsed by Dell Inc..

The LICENSE file provides the standard MIT License text, granting permission to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the software, subject to the inclusion of the copyright notice and permission notice 5. These files ensure that users are aware of the project’s experimental nature and legal boundaries 4 5.

diagram