Commit Message Guidelines

Overview

This document defines the commit message structure, ensuring all commit logs are concise, structured, and informative while removing unnecessary AI-generated labels.

Format

<action verb> <subject> [context]

Guidelines

  • Use present tense, active voice
  • Be descriptive but concise
  • Focus on the change, not the file
  • Start with an action verb

Action Verbs to Use

  • Add (new features)
  • Fix (bug fixes)
  • Update (improvements)
  • Remove (deletions)
  • Refactor (code restructuring)
  • Optimize (performance)
  • Document (documentation)

Structure Rules

  • Keep subject line under 50 characters
  • Use imperative mood ("Add" not "Added")
  • No period at end of subject line

Examples

Good Examples

Add Redis caching for session tokens
Fix dark mode toggle in navigation
Update knowledge graph search algorithm
Remove deprecated API endpoints
Refactor auth flow for Solana login
Optimize knowledge graph queries
Document API authentication process

Bad Examples

❌ AI-Generated Commit Summary
❌ Updates to files
❌ Fixed stuff
❌ Added some features yesterday

Authority Requirements

Certain types of changes require explicit approval from the Human Executive Operator (Joe Maristela):

  • [ARCH] - Architecture changes
  • [SECURITY] - Security-related modifications
  • [CRITICAL] - Critical system changes
  • [IDENTITY] - Changes to identity or authority structure

Implementation

GitHub Actions Workflow

Update .github/workflows/update-memory.yml:

  • Remove "AI-Generated Commit Summary" from commit logs
  • Ensure commit messages include:
    • Modified files
    • Description of changes
    • Timestamp
    • GitHub link

Git Hooks

If using Git hooks for commit messages:

  • Update the prepare-commit-msg hook to apply the new structure
  • Ensure hooks strip any unnecessary metadata

Example Commit Messages

Simple File Change

🔄 Changed Files: memory/session-history.html
📌 Details: Auto-update session history logs
👤 Author: rolodexterVS
✅ Approved: N/A
📅 Timestamp: 2025-02-15 14:50:00 UTC
🔗 GitHub: https://github.com/rolodexter/commit/abc123

Multiple File Updates

🔄 Changed Files: chatbot.html, knowledge-graph.html, update-memory.yml
📌 Details: Implement chatbot integration, update knowledge graph, and refine commit logs
👤 Author: rolodexterGPT
✅ Approved: N/A
📅 Timestamp: 2025-02-15 15:10:30 UTC
🔗 GitHub: https://github.com/rolodexter/commit/xyz789

Next Steps

  1. Update GitHub workflow to apply new commit format
  2. Verify that new commits follow the structure
  3. Test with a sample commit to confirm correctness
  4. Monitor commit logs for consistency