Skip to content

kforkayin/commitizen

Repository files navigation

🎉 commitizen - Create Conventional Commits Easily

🚀 Getting Started

Welcome to commitizen! This tool helps you create conventional commits in your Go projects without any hassle. You don't need Node.js or complex setups. Just follow these steps to get started.

📥 Download and Install

Click the button below to visit the Releases page. Here, you can download the latest version of commitizen:

Download commitizen

Steps to Download

  1. Click the button above.
  2. On the Releases page, you will see a list of available versions.
  3. Look for the latest release and find the download link for your system.
  4. Click the link to begin downloading.

💻 System Requirements

Before you download commitizen, ensure your system meets the following requirements:

  • Operating System: Windows, macOS, or Linux
  • Go installed (version 1.12 or higher recommended)

📁 Running commitizen

After downloading, follow these steps to run commitizen:

  1. Locate the downloaded file on your computer. It may be in your "Downloads" folder or wherever you saved it.

  2. Open a terminal or command prompt.

  3. Navigate to the directory where commitizen is located. For example:

    • On Windows: cd C:\Users\YourUsername\Downloads
    • On macOS/Linux: cd ~/Downloads
  4. Run the following command to execute commitizen:

    ./commitizen
    

    (On Windows, you may need to type commitizen.exe.)

🎯 Usage

Using commitizen is straightforward. Here's how you can create your first conventional commit:

  1. Open a terminal and go to your project folder.
  2. Run commitizen by typing ./commitizen.
  3. Follow the prompts to enter your commit message.
  4. Once finished, commit the changes.

Example

If you're looking to add a feature, you might choose feat: as your commit type and provide a brief description, like this:

feat: add user login functionality

❓ FAQs

Can I use commitizen with existing projects?

Yes, you can easily integrate commitizen into any Go project. Just follow the steps to install and start using it!

Do I need to know Go programming to use commitizen?

No, you don't need any programming knowledge to use commitizen. It is designed to be user-friendly for everyone.

How do I report issues or suggestions?

If you encounter any issues or have suggestions, please visit the Issues section on the commitizen GitHub page.

🔗 Additional Resources

📄 License

This project is licensed under the MIT License. Please see the LICENSE file for details.

📬 Contact

For questions or support, feel free to reach out through the GitHub repository or by opening an issue.

Thank you for using commitizen! Enjoy simplified commit management in your Go projects.