diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 316589e..263c2dd 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -22,7 +22,7 @@ repos: args: [--max-line-length=100, --ignore=E501] exclude: ^commit_check/__init__.py - repo: https://github.com/pre-commit/mirrors-mypy - rev: v1.11.1 + rev: v1.11.2 hooks: - id: mypy additional_dependencies: [types-PyYAML] @@ -32,7 +32,7 @@ repos: hooks: - id: codespell - repo: https://github.com/commit-check/commit-check - rev: v0.8.0 + rev: v0.8.1 hooks: - id: check-message # - id: check-branch # uncomment if you need. diff --git a/README.rst b/README.rst index 9e4a95e..e60af4e 100644 --- a/README.rst +++ b/README.rst @@ -30,33 +30,25 @@ Commit Check Overview -------- -Commit Check supports checking commit messages, branch naming, committer name/email, commit signoff, customizing error messages, suggested commands and more. +**Commit Check** is a free, powerful tool that enforces commit metadata standards, including commit message, branch naming, committer name/email, and commit signoff. Fully customizable with error messages and suggested commands, it ensures compliance across teams. -It is a powerful, free solution for individuals and teams aiming to standardize commit message formatting and branch naming, including - -- writing descriptive commit is easy to read -- identify branch according to the branch type -- triggering the specific types of commit/branch CI build -- automatically generate changelogs - -If you're using Bitbucket, it's an open source alternative to `Yet Another Commit Checker `_. +As an alternative to GitHub Enerprise `Metadata restrictions `_ and Bitbucket's paid puglin `Yet Another Commit Checker `_, Commit Check stands out by integrating DevOps principles and Infrastructure as Code (IaC). Configuration ------------- -Use Custom Configuration -~~~~~~~~~~~~~~~~~~~~~~~~ - -Create a config file ``.commit-check.yml`` under your repository's root directory, e.g., `.commit-check.yml `_ - Use Default Configuration ~~~~~~~~~~~~~~~~~~~~~~~~~ - If you don't set ``.commit-check.yml``, Commit Check will use the `default configuration `_. -- The commit message will follow the rules of `conventional commits `_, - branch naming follow Bitbucket's `branching model `_. +- The commit message will follow the rules of `Conventional Commits `_, + branch naming follow the rules of `Conventional Branch `_. +Use Custom Configuration +~~~~~~~~~~~~~~~~~~~~~~~~ + +Create a config file ``.commit-check.yml`` under your repository's root directory, e.g., `.commit-check.yml `_ Usage -----