Introduce New Pre-Commit Configuration and Documentation

[GatlenCulp]

Overview

This pull request introduces a new pre-commit system to enhance code quality and automate checks before committing. Highlights include:

1. .pre-commit-config.yaml

   • Centralizes hooks for security scanning (GitLeaks), Python linting/formatting (Ruff), JavaScript linting (Biome), notebooks (nbQA), and more.
   • Streamlines standards in a single config file.

2. Documentation

   • Comprehensive “Pre-commit Hooks Collection” explaining installation, usage, and maintenance.
   • Details each hook, provides alternatives, and clarifies why each tool was selected.
   • Introduces newcomers to pre-commit hooks.

3. Configurations for Multiple QA Tools

   • Incorporates BiomeJS, MDFormat, and standard commit-message enforcement with Commitizen.

4. Makefile Integration

   • make pre-commit-test: Tests all hooks.
   • make pre-commit-update: Updates, installs, and tests hooks using the new config.

---

Commits Summary

Highlights

• feat: Create new .pre-commit-config.yaml with curated hooks for security, code quality, Git hygiene, commit message standards, etc.
• docs: Write comprehensive documentation on how to set up and use the new pre-commit system.
• style: Introduce uniform naming conventions and emojis to label each hook category.
• chore: Minor housekeeping related to the new pre-commit install scripts.

---

Testing & Verification

1. Install or Update Pre-Commit

   pip install pre-commit
   pre-commit install

2. Validate

   pre-commit run --all-files

---

Additional Notes

• No backward compatibility concerns: This is a fresh addition; no existing pre-commit or linting pipeline was replaced.
• Future Enhancements: Potential to add Pyright for advanced Python type checking once an official hook is available. (More to do 😵‍💫)