Git Commit Message Standards for ML Projects¶

Generate git commands for staging and committing the following changes. Follow
the structure:

<type>(<scope>): <subject> [#issue_number | #jira_key]

Include all modified files in the `git diff` command. Provide the
complete `git add` and `git commit` commands, including the body and 
footer. Select the right git commit types with emojis. Limit 
comments to 72 characters per line and code lines to 79 characters. 

Output of `git diff` command:

[Please insert the output of the git diff here]

JIRA story number:

[Please enter the JIRA story number here]

Additional Context (Optional):
-----------------------------

[Please insert additional context]

Commit types:
-------------
Here’s the list of git commit types with emojis included:

### Commit Types:

- 🎨 Improve structure/format of the code
- ⚡️ Improve performance
- 🔥 Remove code or files
- 🐛 Fix a bug
- 🚑️ Critical hotfix
- ✨ Introduce new features
- 📝 Add or update documentation
- 🚀 Deploy stuff
- 💄 Add or update the UI and style files
- 🎉 Begin a project
- ✅ Add, update, or pass tests
- 🔒 Fix security or privacy issues
- 🔐 Add or update secrets
- 🔖 Release/Version tags
- 🚨 Fix compiler/linter warnings
- 🚧 Work in progress
- 💚 Fix CI build
- ⬇️ Downgrade dependencies
- ⬆️ Upgrade dependencies
- 📌 Pin dependencies to specific versions
- 👷 Add or update CI build system
- 📈 Add or update analytics or track code
- ♻️ Refactor code
- ➕ Add a dependency
- 🔧 Add or update configuration files
- 🔨 Add or update development scripts
- 🌍 Internationalization and localization
- ✏️ Fix typos
- 💩 Write bad code that needs to be improved
- ⏪️ Revert changes
- 🔀 Merge branches
- 📦️ Add or update compiled files or packages
- 👽 Update code due to external API changes
- 🚚 Move or rename resources (e.g., files, paths, routes)
- 📄 Add or update license
- 💥 Introduce breaking changes
- 🍱 Add or update assets
- ♿️ Improve accessibility
- 💬 Add or update comments in source code
- 🗯️ Write code drunkenly
- 🧪 Add or update text and literals
- 🗃️ Perform database-related changes
- 📝 Add or update logs
- 🔇 Remove logs
- 👤 Add or update contributor(s)
- 🛠️ Improve user experience/usability
- 🏗️ Make architectural changes
- 📱 Work on responsive design
- 🔍 Mock things
- 🥚 Add or update an easter egg
- ➕ Add or update a .gitignore file
- 🧪 Add or update snapshots
- 🔬 Perform experiments
- 🌐 Improve SEO
- 🛑 Add or update types
- 🌱 Add or update seed files
- 🚩 Add, update, or remove feature flags
- ❗ Catch errors
- 📲 Add or update animations and transitions
- 🗑️ Deprecate code that needs to be cleaned up
- 🔑 Work on code related to authorization, roles, and permissions
- 👕 Simple fix for a non-critical issue
- 🔍 Data exploration/inspection
- 🧹 Remove dead code
- 🚨 Add a failing test
- 🧠 Add or update business logic
- 🩺 Add or update health checks
- 🏗️ Infrastructure-related changes
- 🤝 Improve developer experience
- 💵 Add sponsorships or money-related infrastructure
- ⚖️ Add or update code related to multithreading or concurrency
- 🛡️ Add or update code related to validation

Example of Expected Output:
---------------------------

git add mkdocs.yml poetry.lock pyproject.toml
git commit -m "feat(deps): add mkdocs versioning and testing dependencies [#JIRA-123]

Added dependencies for MkDocs versioning and testing to enhance
documentation and development workflows. Updated pyproject.toml
with the following:
- mkdocs-glightbox: to support image lightboxes in documentation
- mike: to manage multiple versions of documentation

Updated poetry.lock with new packages:
- importlib-resources: for resource management in tests
- mike: for documentation version management
- mkdocs-glightbox: for enhanced documentation visuals
- verspec: for flexible version handling

These changes improve documentation flexibility and testing coverage.

Footer notes:
- Consult package documentation for more details.
"

git add utils/helpers.py
git commit -m "🎨 refactor(helpers): update pi precision and greeting format [#JIRA-123]

Updated the `calculate_area` function to use a more precise value
of pi (3.14159) for improved accuracy in area calculations. Also,
refined the `greeting` function to include a comma for better
readability in the output.

These changes enhance both the mathematical accuracy of area
calculations and the user experience with improved greeting
formatting.

Footer notes:
- Consider further enhancements to include localization
  for the greeting function.
"

git add utils/helpers.py
git commit -m "🎨 refactor(helpers): update pi precision and greeting format [#JIRA-123]

Updated the `calculate_area` function to use a more precise value
of pi (3.14159) for improved accuracy in area calculations. Also,
refined the `greeting` function to include a comma for better
readability in the output.

These changes enhance both the mathematical accuracy of area
calculations and the user experience with improved greeting
formatting.

Footer notes:
- Consider further enhancements to include localization
  for the greeting function.
"

<type>(<scope>): <subject> [#issue_number | #jira_key]

<body>

<footer>