• Commiter
  • What it's?
  • Why use it ?
  • Why cosmos commit type ?
• Installation
  • Archlinux user install
• Usage
  • Commit Message Format
    • Commit Types

Commiter

The "Cosmic Commits" project is a convention for writing Git commit messages that uses terms and concepts from astronomy and space exploration to categorize and describe changes made to a codebase. This approach aims to make commit messages more informative, engaging, and easier to understand for developers and project stakeholders.

Key aspects of the Cosmic Commits project:

• Categorization: Commits are categorized based on their nature, such as:

  • Core Changes: New features, bug fixes, refactoring, performance improvements, and documentation updates.
  • Maintenance & Infrastructure: Code cleanup, testing, dependency updates, and infrastructure changes.
  • Special Events: Major milestones, releases, or significant code removals.
  • Communication & Collaboration: Project management updates, urgent fixes, and improvements to communication and documentation.
  • Celestial Events, Celestial Objects, Astronomical Concepts, and Space Exploration: Additional categories with more specific commit types inspired by the cosmos.

• Descriptive Labels: Each commit type is assigned a descriptive label that reflects its purpose, making it easy to identify the type of change at a glance. For example, "Star" for new features, "Comet" for bug fixes, and "Nebula" for refactoring.

• Mnemonic Devices: Some commit types come with mnemonic devices to help remember their meaning and usage. For example, "Comet" stands for "Code or Module Error Terminated."

• Structured Format: The project recommends a consistent commit message format, such as:

  <type>(<scope>): <short summary>
  
  [Optional body with more details]
  
  [Optional footer(s)]
  

• Flexibility and Customization: The list of commit types is flexible and can be adapted to the specific needs and terminology of different projects. Teams are encouraged to create their own cosmic terms or modify existing ones to better suit their workflow.

• Tooling: The project can be enhanced with tools like commitizen or cz-cli to automate commit message creation and validation, ensuring consistency and adherence to the chosen conventions.

The overall goal of Cosmic Commits is to make Git commit messages more informative, engaging, and enjoyable for developers, ultimately leading to better collaboration, maintainability, and understanding of the project's history.

Why use it ?

1. Team Adoption:

• Discuss and Agree: Initiate a conversation with your team about using cosmic commit types. Explain the benefits, share this comprehensive guide, and gather feedback.
• Customize: Collaboratively decide on the specific commit types you want to use. You can start with the comprehensive list provided here and tailor it to your project's specific needs and preferences.
• Document: Create a clear and concise reference document outlining the chosen commit types, their meanings, and examples. Make this document easily accessible to all team members.

2. Implementation:

• Manual Approach: You can start using cosmic commit types manually by simply adhering to the <type>(<scope>): <short summary> format in your commit messages.
• Git Commit Template: Create a Git commit template file (e.g., .gitmessage) to automatically populate the commit message format in your editor. This can help enforce consistency and remind contributors of the available commit types.
• Git Hooks: Utilize Git hooks, like the prepare-commit-msg hook, to validate your commit messages and ensure they conform to the chosen format.
• Automated Tools: Consider leveraging tools like commitizen or cz-cli that provide interactive prompts for creating commit messages according to your chosen convention. These tools can streamline the process and enforce consistency across your team.

3. Continuous Improvement:

• Regular Review: Periodically review your team's commit history to ensure consistent usage of the cosmic commit types and identify any areas where the format could be refined or improved.
• Feedback Loop: Encourage open communication and feedback from your team members about the effectiveness of the chosen commit types and any suggestions for improvement.
• Iterative Refinement: Don't be afraid to experiment and adapt the commit types to better suit your evolving project needs. The key is to find a system that works well for your team and enhances your Git workflow.

4. Continuous Improvement:

• Encourage Creativity: While maintaining consistency, allow team members to add their own flair and personality to the commit messages within the established framework.
• Celebrate Milestones: Use special event commit types like "Moon Landing" to celebrate significant achievements and keep your team motivated.
• Integration with Other Tools: Explore integration options with your issue tracking system, CI/CD pipeline, or documentation tools to automate processes and maximize the benefits of using cosmic commit types.

By embracing this comprehensive guide and incorporating cosmic commit types into your Git workflow, you can transform your commit history into a vibrant, informative, and enjoyable reflection of your project's journey.

5. Commit Graph Example:

* Big Bang: Initial project creation
    |\
    | *--* Star (UI): Implement initial user interface
    | *--* Star (API): Create basic API endpoints
    | *--* Nebula (Backend): Refactor project structure for modularity
    |    |\
    |    | *--* Comet (UI): Fix responsive design issue on mobile
    |    | *--* Pulsar (API): Optimize database queries for faster response
    |    *--* Launch (v0.1): First version deployed to staging
    |\
    | *--* Star (Search): Add new search functionality
    | *--* Solar Flare (Tests): Add unit and integration tests for search
    | *--* Quasar (Docs): Update documentation with search instructions
    |    |\
    |    | *--* Comet (Search): Fix bug in search result ranking
    |    *--* Launch (v0.2): Release new version with search feature to production
    |\
    | *--* Black Hole: Remove deprecated user management module
    | *--* Wormhole: Merge feature/payment-integration branch
    |    |\
    |    | *--* Star (Payments): Integrate Stripe payment gateway
    |    | *--* Solar Flare (Payments): Add tests for payment processing
    |    *--* Launch (v0.3): Release version with payment functionality
    |\
    | *--* Asteroid Belt: Cleanup unused code and optimize images
    | *--* Mission Control: Update project roadmap and assign tasks
    | *--* Spacewalk (Security): Patch critical vulnerability in authentication
    | *--* Moon Landing: Successfully launch version 1.0 to production
    *--* (ongoing development)

Why cosmos commit type ?

Cosmic commit types offer a unique and engaging way to categorize and describe changes in your Git commit history. Here's why they are beneficial:

1. Enhanced Clarity and Communication:

• Descriptive Labels: Using terms like "Star" for new features, "Comet" for bug fixes, or "Nebula" for refactoring instantly conveys the nature of the change to anyone reading the commit log. This improves communication and understanding within the team.
• Visual Scanning: The use of vivid imagery associated with celestial bodies and events makes it easier to quickly scan through a commit history and identify specific types of changes.
• Contextual Information: The optional addition of a scope within the commit message provides further context about which part of the codebase was affected (e.g., "Star(UI)" for a new UI feature).

2. Improved Organization and Maintainability:

• Structured Format: The consistent format of cosmic commit messages (e.g., "Type(Scope): Short summary") makes the commit history more organized and easier to parse. This helps with tasks like generating changelogs or filtering commits based on specific criteria.
• Streamlined History: A well-organized commit history makes it easier to track the evolution of the project, identify patterns, and quickly pinpoint the introduction of specific changes.

3. Increased Engagement and Fun:

• Creative Expression: The cosmic theme adds a touch of personality and fun to the often mundane task of writing commit messages. It can make the development process more enjoyable and engaging for the team.
• Shared Vocabulary: Using a common set of commit types fosters a sense of shared understanding and camaraderie within the team. It can also serve as a fun conversation starter or icebreaker.

4. Automation and Tooling:

• Changelog Generation: Many tools can automatically generate changelogs or release notes by parsing commit messages. Cosmic commit types make this process even easier by providing a clear structure and consistent vocabulary that tools can easily understand.
• Issue Tracking Integration: If you reference issue numbers in your commit messages, some tools can automatically link commits to their corresponding issues, streamlining your workflow and keeping your project management tools up-to-date.

In summary, cosmic commit types offer a more descriptive, organized, and engaging way to document your project's history. They improve communication, streamline workflows, and add a touch of fun to the development process.

Would you like me to elaborate on any of these points or provide more examples of how cosmic commit types can be used in practice?

Installation

cargo install zuu commiter

Archlinux user install

paru -S commiter

Usage

cd repository && commiter

Commit Message Format

<type>(<scope>): <short summary>

[Optional body with more details]

[Optional footer(s)]

Commit Types