#git-commit #commit #git #quality #cargo

app commiter

A rust program to ensure the quality of commit

14 stable releases (5 major)

5.0.0 Oct 7, 2024
4.1.0 Jul 24, 2024
3.0.0 Jul 19, 2024
2.2.2 Jul 19, 2024
0.0.1 Jun 2, 2024

#116 in Development tools

Download history 6/week @ 2024-07-01 412/week @ 2024-07-15 303/week @ 2024-07-22 19/week @ 2024-07-29 5/week @ 2024-09-23 208/week @ 2024-10-07 32/week @ 2024-10-14

245 downloads per month

Custom license

86KB
495 lines

Installation

For the moment only feature cli is implemented

cargo install commiter --features git --features cli

Supported : git mercurial fossil pijul

Help

commiter --help

Templates

List

commiter template list

Add

commiter template add

Remove

commiter template remove -t template

Available by default

templates
├── alerting-update.txt
├── api-change.txt
├── api-documentation.txt
├── api.txt
├── audit.txt
├── backup-creation.txt
├── build.txt
├── cache-update.txt
├── cherry-pick.txt
├── chore.txt
├── ci.txt
├── cleanup.txt
├── compliance.txt
├── config.txt
├── database-migration.txt
├── dependency-removal.txt
├── dependency-update.txt
├── deployment.txt
├── deprecate.txt
├── deprecation-notice.txt
├── docs.txt
├── experiment.txt
├── feat.txt
├── feature-addition.txt
├── feature-toggle.txt
├── fix.txt
├── hotfix.txt
├── hotpatch.txt
├── log-rotation-update.txt
├── log-update.txt
├── merge.txt
├── migration.txt
├── minor-update.txt
├── monitoring-update.txt
├── optimize.txt
├── perf.txt
├── refactor.txt
├── remove.txt
├── revert.txt
├── rollback-deployment.txt
├── rollback.txt
├── schema-update.txt
├── secret-update.txt
├── security-patch.txt
├── security.txt
├── services.txt
├── squash.txt 
├── style.txt
├── testing-environment-update.txt
├── test.txt
├── update.txt
└── version-bump.txt

1 directory, 52 files

Get templates

git clone https://github.com/otechdo/commit /tmp/commit && cp -rv /tmp/commit/templates $HOME/templates

Usage

require manual track files

For alerting-update

Run

commiter commit -t alerting-update

Output

ALERTING UPDATE: {{ commit_message }}

Details:

    * Alerts added/modified for: {{ system_or_service }}.
    * New thresholds: {{ new_thresholds }}.
    * Notifications sent to: {{ notification_channels }}.
    * Reason for update: {{ reason_for_update }}.

Impact:

    * Incident detection improved.
    * Response time improved: {{ response_time_improvement }}.

Author: {{ author }}
Date:   {{ commit_date }}
Parent Commit: {{ parent_commit }}

For api-change

Run

commiter commit -t api-change

Output

API CHANGE: {{ commit_message }}

Details:

    * API endpoint changed: {{ endpoint }}.
    * Reason for change: {{ reason_for_change }}.
    * Breaking changes: {{ breaking_changes }}.
    * New parameters: {{ new_parameters }}.
    * Deprecated endpoints: {{ deprecated_endpoints }}.

Impact:

    * API consumers impact: {{ consumer_impact }}.
    * Response time improvement: {{ response_time_improvement }}.

Author: {{ author }}
Date:   {{ commit_date }}
Parent Commit: {{ parent_commit }}

For api-documentation

Run

commiter commit -t api-documentation

Output

API DOCUMENTATION: {{ commit_message }}

Details:

    * Documentation updated for: {{ api_endpoint }}.
    * Changes applied: {{ changes_applied }}.
    * New sections added: {{ new_sections }}.

Impact:

    * Documentation completeness improved.
    * API consumer understanding enhanced.

Author: {{ author }}
Date:   {{ commit_date }}
Parent Commit: {{ parent_commit }}

For api

Run

commiter commit -t api

Output

API CHANGE: {{ commit_message }}

Details:

    * API endpoint affected: {{ endpoint }}.
    * Change type: {{ change_type }} (Addition, Modification, Removal).
    * Breaking changes: {{ breaking_changes }}.
    * New parameters: {{ new_parameters }}.
    * Deprecated endpoints: {{ deprecated_endpoints }}.

Impact:

    * Impact on API consumers: {{ consumer_impact }}.
    * Documentation updated: {{ documentation_update }}.

Author: {{ author }}
Date: {{ commit_date }}

Parent Commit: {{ parent_commit }}

For audit

Run

commiter commit -t audit

Output

AUDIT: {{ commit_message }}

Details:

    * Audit conducted on: {{ system_or_service }}.
    * Security vulnerabilities found: {{ vulnerabilities_found }}.
    * Recommended actions: {{ recommended_actions }}.

Impact:

    * System security posture improved.
    * Compliance status: {{ compliance_status }}.

Author: {{ author }}
Date:   {{ commit_date }}
Parent Commit: {{ parent_commit }}

For backup-creation

Run

commiter commit -t backup-creation

Output

BACKUP CREATION: {{ commit_message }}

Details:

    * Backup created for: {{ system_or_service }}.
    * Data size: {{ data_size }}.
    * Storage location: {{ storage_location }}.

Impact:

    * Backup ensures data integrity and recovery options.
    * Backup time: {{ backup_time }}.

Author: {{ author }}
Date:   {{ commit_date }}
Parent Commit: {{ parent_commit }}

For build

Run

commiter commit -t build

Output

BUILD: {{ commit_message }}

Dependency update:

    * Updated dependencies: {{ dependencies_updated }}.
    * Reason for update: {{ reason_for_update }}.
    * Version change: {{ version_change }}.

Impact:

    * Build stability and performance improved.
    * Issues resolved: {{ issues_resolved }}.

Author: {{ author }}
Date:   {{ commit_date }}
Parent Commit: {{ parent_commit }}

For cache-update

Run

commiter commit -t cache-update

Output

CACHE UPDATE: {{ commit_message }}

Details:

    * Cache updated for: {{ system_or_service }}.
    * Cache expiry set to: {{ cache_expiry }}.
    * Cache invalidated for: {{ invalidated_items }}.

Impact:

    * Improved system performance and data freshness.
    * Response time improvement: {{ response_time_improvement }}.

Author: {{ author }}
Date:   {{ commit_date }}
Parent Commit: {{ parent_commit }}

For cherry-pick

Run

commiter commit -t cherry-pick

Output

CHERRY PICK: {{ commit_message }}

Details:

    * Commit cherry-picked from: {{ source_branch }}.
    * Reason for cherry-picking: {{ reason_for_cherry_picking }}.

Impact:

    * Feature/bugfix applied to: {{ target_branch }}.
    * Conflicts resolved: {{ conflicts_resolved }}.

Author: {{ author }}
Date:   {{ commit_date }}
Parent Commit: {{ parent_commit }}

For chore

Run

commiter commit -t chore

Output

CHORE: {{ commit_message }}

Details:

    * Routine task performed: {{ task }}.
    * System affected: {{ system_or_service }}.

Impact:

    * Codebase maintenance or improvement.

Author: {{ author }}
Date:   {{ commit_date }}
Parent Commit: {{ parent_commit }}

For ci

Run

commiter commit -t ci

Output

CI UPDATE: {{ commit_message }}

Details:

    * CI pipeline changes: {{ ci_changes }}.
    * CI tool/version updated: {{ ci_tool_version }}.
    * CI task added/modified: {{ ci_task }}.

Impact:

    * Build automation improved.
    * Test coverage impact: {{ test_coverage_impact }}.

Author: {{ author }}
Date:   {{ commit_date }}
Parent Commit: {{ parent_commit }}

For cleanup

Run

commiter commit -t cleanup

Output

CLEANUP: {{ commit_message }}

Details:

    * Cleanup performed on: {{ system_or_service }}.
    * Files/Resources removed: {{ resources_removed }}.

Impact:

    * Codebase or system efficiency improved.
    * Unnecessary resources removed.

Author: {{ author }}
Date:   {{ commit_date }}
Parent Commit: {{ parent_commit }}

For compliance

Run

commiter commit -t compliance

Output

COMPLIANCE: {{ commit_message }}

Details:

    * Compliance rule applied: {{ compliance_rule }}.
    * System/Module affected: {{ system_or_module }}.
    * Compliance standard: {{ compliance_standard }}.
    * Audit trail updated: {{ audit_trail_updated }}.

Impact:

    * Compliance with {{ compliance_standard }} ensured.
    * Legal and regulatory risks reduced.

Author: {{ author }}
Date:   {{ commit_date }}
Parent Commit: {{ parent_commit }}

For config

Run

commiter commit -t config

Output

CONFIG: {{ commit_message }}

Details:

    * Configuration changed for: {{ system_or_service }}.
    * New configuration values: {{ new_configuration }}.
    * Previous configuration values: {{ previous_configuration }}.

Impact:

    * Configuration changes ensure: {{ configuration_impact }}.

Author: {{ author }}
Date:   {{ commit_date }}
Parent Commit: {{ parent_commit }}

For database-migration

Run

commiter commit -t database-migration

Output

DATABASE MIGRATION: {{ commit_message }}

Details:

    * Migration type: {{ migration_type }}.
    * Affected tables: {{ affected_tables }}.
    * Data integrity check: {{ data_integrity_check }}.
    * Downtime required: {{ downtime_required }}.

Impact:

    * Data migration impact: {{ data_migration_impact }}.
    * Performance impact: {{ performance_impact }}.
    * Backup status: {{ backup_status }}.

Author: {{ author }}
Date:   {{ commit_date }}
Parent Commit: {{ parent_commit }}

For dependency-removal

Run

commiter commit -t dependency-removal

Output

DEPENDENCY REMOVAL: {{ commit_message }}

Details:

    * Removed dependencies: {{ removed_dependencies }}.
    * Reason for removal: {{ reason_for_removal }}.
    * Affected modules: {{ affected_modules }}.

Impact:

    * Codebase size reduced.
    * Build time improvements: {{ build_time_improvements }}.

Author: {{ author }}
Date:   {{ commit_date }}
Parent Commit: {{ parent_commit }}

For dependency-update

Run

commiter commit -t dependency-update

Output

DEPENDENCY UPDATE: {{ commit_message }}

Details:

    * Updated dependencies: {{ updated_dependencies }}.
    * Reason for update: {{ reason_for_update }}.
    * Previous version: {{ previous_version }}.
    * Updated version: {{ updated_version }}.

Impact:

    * Performance and security improvements.
    * Issues resolved: {{ issues_resolved }}.

Author: {{ author }}
Date:   {{ commit_date }}
Parent Commit: {{ parent_commit }}

For deployment

Run

commiter commit -t deployment

Output

DEPLOYMENT: {{ commit_message }}

Details:

    * Deployed version: {{ deployed_version }}.
    * Environment: {{ environment }} (e.g., production, staging).
    * Downtime duration: {{ downtime_duration }}.

Impact:

    * System/service availability: {{ availability_status }}.
    * Issues during deployment: {{ deployment_issues }}.

Author: {{ author }}
Date:   {{ commit_date }}
Parent Commit: {{ parent_commit }}

For deprecate

Run

commiter commit -t deprecate

Output

DEPRECATE: {{ commit_message }}

Details:

    * Deprecated feature: {{ deprecated_feature }}.
    * Replacement feature: {{ replacement_feature }}.
    * Reason for deprecation: {{ reason_for_deprecation }}.

Impact:

    * Users need to migrate to: {{ replacement_feature }}.
    * Migration guide available: {{ migration_guide }}.

Author: {{ author }}
Date:   {{ commit_date }}
Parent Commit: {{ parent_commit }}

For deprecation-notice

Run

commiter commit -t deprecation-notice

Output

DEPRECATION NOTICE: {{ commit_message }}

Details:

    * Feature to be deprecated: {{ feature_to_deprecate }}.
    * Deprecation timeline: {{ deprecation_timeline }}.
    * Replacement feature: {{ replacement_feature }}.

Impact:

    * User migration required.
    * End of life date: {{ eol_date }}.
    * Documentation updated: {{ documentation_update }}.

Author: {{ author }}
Date:   {{ commit_date }}
Parent Commit: {{ parent_commit }}

For docs

Run

commiter commit -t docs

Output

DOCUMENTATION UPDATE: {{ commit_message }}

Details:

    * Sections updated: {{ updated_sections }}.
    * New sections added: {{ new_sections }}.
    * Technical changes documented: {{ changes_documented }}.

Impact:

    * Documentation completeness improved.
    * User/Developer guidance enhanced.

Author: {{ author }}
Date:   {{ commit_date }}
Parent Commit: {{ parent_commit }}

For experiment

Run

commiter commit -t experiment

Output

EXPERIMENT: {{ commit_message }}

Details:

    * Experimental feature: {{ experimental_feature }}.
    * Hypothesis: {{ hypothesis }}.
    * Test duration: {{ test_duration }}.
    * Metrics to be tracked: {{ tracked_metrics }}.

Impact:

    * Experiment outcomes will inform: {{ outcome_impact }}.
    * Risks: {{ risks }}.

Author: {{ author }}
Date:   {{ commit_date }}
Parent Commit: {{ parent_commit }}

For feat

Run

commiter commit -t feat

Output

FEATURE ADDITION: {{ commit_message }}

Details:

    * New feature: {{ feature_name }}.
    * Reason for addition: {{ reason_for_addition }}.
    * Affected modules: {{ affected_modules }}.

Impact:

    * User experience enhanced.
    * New capabilities available: {{ new_capabilities }}.

Author: {{ author }}
Date:   {{ commit_date }}
Parent Commit: {{ parent_commit }}

For feature-addition

Run

commiter commit -t feature-addition

Output

FEATURE ADDITION: {{ commit_message }}

Details:

    * Feature added: {{ feature_name }}.
    * Reason for addition: {{ reason_for_addition }}.
    * Modules affected: {{ affected_modules }}.
    * Dependencies introduced: {{ dependencies_introduced }}.

Impact:

    * New functionality: {{ new_functionality }}.
    * User benefit: {{ user_benefit }}.

Author: {{ author }}
Date:   {{ commit_date }}
Parent Commit: {{ parent_commit }}

For feature-toggle

Run

commiter commit -t feature-toggle

Output

FEATURE TOGGLE: {{ commit_message }}

Details:

    * Feature toggled: {{ feature_toggled }}.
    * Reason for toggling: {{ reason_for_toggling }}.
    * Status: {{ toggle_status }} (Enabled/Disabled).

Impact:

    * Modules affected: {{ affected_modules }}.
    * User impact: {{ user_impact }}.

Author: {{ author }}
Date:   {{ commit_date }}
Parent Commit: {{ parent_commit }}

For fix

Run

commiter commit -t fix

Output

FIX: {{ commit_message }}

Details:

    * Issue fixed: {{ issue_fixed }}.
    * Module affected: {{ affected_module }}.
    * Root cause: {{ root_cause }}.
    * Solution applied: {{ solution_applied }}.

Impact:

    * System stability restored.
    * Incident resolution time: {{ resolution_time }}.

Author: {{ author }}
Date:   {{ commit_date }}
Parent Commit: {{ parent_commit }}

For hotfix

Run

commiter commit -t hotfix

Output

HOTFIX: {{ commit_message }}

Details:

    * Issue hotfixed: {{ issue_hotfixed }}.
    * Reason for hotfix: {{ reason_for_hotfix }}.
    * Affected module: {{ affected_module }}.
    * Patch applied: {{ patch_applied }}.

Impact:

    * Service disruption minimized.
    * Immediate resolution: {{ resolution_time }}.

Author: {{ author }}
Date:   {{ commit_date }}
Parent Commit: {{ parent_commit }}

For hotpatch

Run

commiter commit -t hotpatch

Output

HOTPATCH: {{ commit_message }}

Details:

    * Hotpatch applied to: {{ system_or_service }}.
    * Issue resolved: {{ issue_resolved }}.
    * Affected module: {{ affected_module }}.

Impact:

    * No downtime required.
    * System performance restored: {{ system_performance_restored }}.

Author: {{ author }}
Date:   {{ commit_date }}
Parent Commit: {{ parent_commit }}

For log-rotation-update

Run

commiter commit -t log-rotation-update

Output

LOG ROTATION UPDATE: {{ commit_message }}

Details:

    * Log rotation policy updated for: {{ system_or_service }}.
    * New retention period: {{ retention_period }}.
    * Log rotation frequency: {{ rotation_frequency }}.

Impact:

    * Storage space optimized.
    * Improved logging efficiency.

Author: {{ author }}
Date:   {{ commit_date }}
Parent Commit: {{ parent_commit }}

For log-update

Run

commiter commit -t log-update

Output

LOG UPDATE: {{ commit_message }}

Details:

    * Log format updated for: {{ system_or_service }}.
    * New log format: {{ new_log_format }}.
    * Affected modules: {{ affected_modules }}.

Impact:

    * Enhanced log readability.
    * Improved monitoring and troubleshooting.

Author: {{ author }}
Date:   {{ commit_date }}
Parent Commit: {{ parent_commit }}

For merge

Run

commiter commit -t merge

Output

MERGE: {{ commit_message }}

Details:

    * Merged branch: {{ merged_branch }} into {{ target_branch }}.
    * Conflicts resolved: {{ conflicts_resolved }}.
    * Reason for merge: {{ reason_for_merge }}.

Impact:

    * Features/bugfixes merged from: {{ source_branch }}.
    * Codebase integration improved.

Author: {{ author }}
Date:   {{ commit_date }}
Parent Commit: {{ parent_commit }}

For migration

Run

commiter commit -t migration

Output

MIGRATION: {{ commit_message }}

Details:

    * Migration type: {{ migration_type }}.
    * Data migrated: {{ data_migrated }}.
    * Downtime required: {{ downtime_required }}.

Impact:

    * System functionality: {{ system_functionality_impact }}.
    * Data integrity maintained: {{ data_integrity }}.

Author: {{ author }}
Date:   {{ commit_date }}
Parent Commit: {{ parent_commit }}

For minor-update

Run

commiter commit -t minor-update

Output

MINOR UPDATE: {{ commit_message }}

Details:

    * Minor update applied to: {{ system_or_service }}.
    * Affected modules: {{ affected_modules }}.
    * Changes: {{ changes }}.

Impact:

    * Small improvements or bugfixes.
    * No significant impact on functionality.

Author: {{ author }}
Date:   {{ commit_date }}
Parent Commit: {{ parent_commit }}

For monitoring-update

Run

commiter commit -t monitoring-update

Output

MONITORING UPDATE: {{ commit_message }}

Details:

    * Monitoring system updated for: {{ system_or_service }}.
    * New monitoring thresholds: {{ new_thresholds }}.
    * Alerts configuration: {{ alerts_configuration }}.

Impact:

    * Improved system visibility.
    * Faster response to incidents.

Author: {{ author }}
Date:   {{ commit_date }}
Parent Commit: {{ parent_commit }}

For optimize

Run

commiter commit -t optimize

Output

OPTIMIZATION: {{ commit_message }}

Details:

    * Module optimized: {{ optimized_module }}.
    * Performance bottleneck resolved: {{ bottleneck }}.
    * Resource usage reduced: {{ resource_usage_reduction }}.

Impact:

    * System performance improved.
    * Response time improvement: {{ response_time_improvement }}.

Author: {{ author }}
Date:   {{ commit_date }}
Parent Commit: {{ parent_commit }}

For perf

Run

commiter commit -t perf

Output

PERFORMANCE IMPROVEMENT: {{ commit_message }}

Details:

    * Performance optimized for: {{ system_or_service }}.
    * Reason for improvement: {{ reason_for_improvement }}.
    * Bottleneck resolved: {{ bottleneck }}.

Impact:

    * Improved performance metrics.
    * System response time reduced by: {{ response_time_improvement }}.

Author: {{ author }}
Date:   {{ commit_date }}
Parent Commit: {{ parent_commit }}

For refactor

Run

commiter commit -t refactor

Output

REFACTOR: {{ commit_message }}

Details:

    * Refactor applied to: {{ affected_module }}.
    * Reason for refactor: {{ reason_for_refactor }}.
    * Code structure improved in: {{ improved_structure }}.

Impact:

    * Code readability enhanced.
    * Performance impact: {{ performance_impact }}.

Author: {{ author }}
Date:   {{ commit_date }}
Parent Commit: {{ parent_commit }}

For remove

Run

commiter commit -t remove

Output

REMOVE: {{ commit_message }}

Details:

    * Feature removed: {{ removed_feature }}.
    * Reason for removal: {{ reason_for_removal }}.
    * Modules affected: {{ affected_modules }}.

Impact:

    * Unused or deprecated code eliminated.
    * Codebase simplified and optimized.

Author: {{ author }}
Date:   {{ commit_date }}
Parent Commit: {{ parent_commit }}

For revert

Run

commiter commit -t revert

Output

REVERT: {{ commit_message }}

Details:

    * Reverted commit: {{ reverted_commit }}.
    * Reason for revert: {{ reason_for_revert }}.
    * Changes undone: {{ changes_undone }}.

Impact:

    * Codebase restored to a previous stable state.
    * Issues with the reverted commit resolved.

Author: {{ author }}
Date:   {{ commit_date }}
Parent Commit: {{ parent_commit }}

For rollback-deployment

Run

commiter commit -t rollback-deployment

Output

ROLLBACK DEPLOYMENT: {{ commit_message }}

Details:

    * Rolled back version: {{ rolled_back_version }}.
    * Reason for rollback: {{ reason_for_rollback }}.
    * Downtime duration: {{ downtime_duration }}.

Impact:

    * Previous stable version restored.
    * System availability ensured.

Author: {{ author }}
Date:   {{ commit_date }}
Parent Commit: {{ parent_commit }}

For rollback

Run

commiter commit -t rollback

Output

ROLLBACK: {{ commit_message }}

Details:

    * Rolled back changes: {{ rolled_back_changes }}.
    * Reason for rollback: {{ reason_for_rollback }}.
    * Affected modules: {{ affected_modules }}.

Impact:

    * System restored to a stable state.
    * Risk of system instability mitigated.

Author: {{ author }}
Date:   {{ commit_date }}
Parent Commit: {{ parent_commit }}

For schema-update

Run

commiter commit -t schema-update

Output

SCHEMA UPDATE: {{ commit_message }}

Details:

    * Database schema updated for: {{ affected_database }}.
    * New schema version: {{ schema_version }}.
    * Tables/Columns affected: {{ affected_tables }}.

Impact:

    * Database integrity maintained.
    * System performance: {{ performance_impact }}.

Author: {{ author }}
Date:   {{ commit_date }}
Parent Commit: {{ parent_commit }}

For secret-update

Run

commiter commit -t secret-update

Output

SECRET UPDATE: {{ commit_message }}

Details:

    * Secret updated for: {{ system_or_service }}.
    * Secret rotation applied: {{ rotation_applied }}.
    * Expiry of previous secret: {{ expiry_date }}.

Impact:

    * Security posture improved.
    * Risk of compromised secrets mitigated.

Author: {{ author }}
Date:   {{ commit_date }}
Parent Commit: {{ parent_commit }}

For security-patch

Run

commiter commit -t security-patch

Output

SECURITY PATCH: {{ commit_message }}

Details:

    * Vulnerability fixed: {{ vulnerability_fixed }}.
    * Affected modules: {{ affected_modules }}.
    * Security risk level: {{ security_risk_level }}.

Impact:

    * System security improved.
    * Compliance status: {{ compliance_status }}.

Author: {{ author }}
Date:   {{ commit_date }}
Parent Commit: {{ parent_commit }}

For security

Run

commiter commit -t security

Output

SECURITY UPDATE: {{ commit_message }}

Details:

    * Security update applied to: {{ system_or_service }}.
    * Risk mitigated: {{ risk_mitigated }}.
    * Security protocols enhanced: {{ security_protocols }}.

Impact:

    * System protection improved.
    * Threat vectors reduced.

Author: {{ author }}
Date:   {{ commit_date }}
Parent Commit: {{ parent_commit }}

For services

Run

commiter commit -t services

Output

SERVICES UPDATE: {{ commit_message }}

Details:

    * Service updated: {{ service_name }}.
    * New features introduced: {{ new_features }}.
    * Performance improvements: {{ performance_improvements }}.

Impact:

    * Service availability: {{ availability_status }}.
    * User experience enhanced.

Author: {{ author }}
Date:   {{ commit_date }}
Parent Commit: {{ parent_commit }}

For style

Run

commiter commit -t style

Output

STYLE: {{ commit_message }}

Details:

    * Code style updated for: {{ affected_modules }}.
    * Linting rules applied: {{ linting_rules }}.
    * Formatting changes: {{ formatting_changes }}.

Impact:

    * Code readability improved.
    * Code consistency maintained.

Author: {{ author }}
Date:   {{ commit_date }}
Parent Commit: {{ parent_commit }}

For test

Run

commiter commit -t test

Output

TEST: {{ commit_message }}

Details:

    * Test written for: {{ feature_or_module }}.
    * Test coverage improved: {{ test_coverage }}.
    * Tests passed: {{ tests_passed }}.

Impact:

    * Code reliability improved.
    * Bugs or issues detected: {{ bugs_detected }}.

Author: {{ author }}
Date:   {{ commit_date }}
Parent Commit: {{ parent_commit }}

For testing-environment-update

Run

commiter commit -t testing-environment-update

Output

TESTING ENVIRONMENT UPDATE: {{ commit_message }}

Details:

    * Testing environment updated for: {{ system_or_service }}.
    * Test coverage improvements: {{ test_coverage }}.
    * Test suite updated: {{ test_suite_update }}.

Impact:

    * Testing efficiency improved.
    * More comprehensive test scenarios covered.

Author: {{ author }}
Date:   {{ commit_date }}
Parent Commit: {{ parent_commit }}

For update

Run

commiter commit -t update

Output

UPDATE: {{ commit_message }}

Details:

    * System update applied to: {{ system_or_service }}.
    * Changes introduced: {{ changes_introduced }}.
    * Modules affected: {{ affected_modules }}.

Impact:

    * System functionality improved.
    * Performance impact: {{ performance_impact }}.

Author: {{ author }}
Date:   {{ commit_date }}
Parent Commit: {{ parent_commit }}

For version-bump

Run

commiter commit -t version-bump

Output

VERSION BUMP: {{ commit_message }}

Details:

    * Version bumped from: {{ previous_version }} to {{ new_version }}.
    * Reason for version bump: {{ reason_for_bump }}.
    * Changes introduced: {{ changes_introduced }}.

Impact:

    * System compatibility ensured.
    * User notification required: {{ user_notification_required }}.

Author: {{ author }}
Date:   {{ commit_date }}
Parent Commit: {{ parent_commit }}

Dependencies

~3–27MB
~433K SLoC