Skip to content

Latest commit

 

History

History
172 lines (113 loc) · 4.84 KB

README.md

File metadata and controls

172 lines (113 loc) · 4.84 KB
Raw

CommitSense

CommitSense is a command-line tool that simplifies Git version control by providing an interactive and standardized way to create commit messages following the Conventional Commits specification.

Features

  • Conventional Commits-based commit message generation.
  • Improved commit message consistency.
  • Streamlined Git workflow.

Here's the cool part: CommitSense plays well with native Git commands under the hood. So, while you're using Git commands like a console wizard, CommitSense is right there, ensuring compatibility and helping you create those commits with style when you're ready!

Install

Homebrew

Check out the homebrew formula repository for installation guide.

Other

You can always clone the repository, build the application and use the binary for running the application.

Usage

Creating Commits

Creating commits for staged changes can be done using the following command:

commitsense commit

This command guides you through creating a commit message according to the Conventional Commits format.

Starting from v1.0.0 you can also use "shorthand" commands to create commit messages with out the guidance:

commitsense feat "Add a new feature"

# Also marking commits as breaking change is possible
commitsense feat -b "Breaking changes"

# And of course adding a commit scope 
commitsense fix -s core "Fix a critical bug in production"

Coauthored Commits

If you wish to add co-authors for the commits you can append the commit command with the flag -a:

commitsense commit -a

This will prompt you with the users that HAVE already made commits to the same git repository.

Breaking Change Commits

If your commits introduce breaking changes, you can append the commit command with the flag -b:

commitsense commit -b

This will add the breaking change notation to the final commit message on your behalf.

Configuration

By default CommitSense will create a default configuration file with the following contents:

{
  "commit_types": [
    "feat",
    "fix",
    "docs",
    "style",
    "refactor",
    "perf",
    "test",
    "build",
    "ci",
    "chore",
    "revert"
  ],
  "skip_ci_types": [
    "docs"
  ],
  "version": 1
}

The commit_types will be shown on the usage of commit command, and you can alter this array to your own liking. However keep in mind that if you want to follow Conventional commits spec, you must atleast have fix and feat types.

The skip_ci_types will automatically add information to skip ci run on configured types. This can be empty.

The configuration file is saved to the root of the project as an JSON file. This can be further modified to your own needs and it will persist the changes. On each run this configuraion file is checked.

For collaboration on a project using CommitSense it is sensible to put the configuration file to version control.

Development

Building the application locally

To build the application run the following command:

go build .

This will create a binary named commitsense to the root of the project.

To run the built application run ./commitsense [command] in the root of the project.

golangci-lint

golangci-lint is a fast and customizable Go linter. It provides a wide range of checks for various aspects of your Go code.

To install golangci-lint, run the following command:

go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest

Running golangci-lint

To run golangci-lint on your project, navigate to your project's root directory and execute:

golangci-lint run

This command will analyze your Go code, check for issues, and display the results.

To run and fix autofixable problems, run the following command:

golangci-lint run --fix

gofumpt

gofumpt is a stricter Go code formatter that follows the gofumpt style.

To install gofumpt, run:

go install mvdan.cc/gofumpt@latest

Running gofumpt

To format and organize your import statements, run:

gofumpt -l -w .

Contributing

We welcome contributions to CommitSense! To contribute, follow these steps:

  • Fork this repository.
  • Create a new branch for your feature or bug fix: git checkout -b my-feature.
  • Commit your changes following the Conventional Commits format.
  • Push your branch to your fork: git push origin my-feature.
  • Open a pull request to the main repository.
  • Please ensure your code follows best practices and includes appropriate tests.

License

CommitSense is released under the MIT License. See LICENSE for details.

Acknowledgments

This project is inspired by the Conventional Commits specification. Learn more at Conventional Commits.