<p align="center">
<a href="https://sumi.rs">
<img src="https://raw.githubusercontent.com/welpo/git-sumi/main/website/static/img/logo.png" width="300" alt="git-sumi logo: a lantern held on a bamboo stick over the sea">
</a>
<br><br>
<a href="https://github.com/welpo/git-sumi">
<img src="https://img.shields.io/badge/clean_commits-git--sumi-0?style=flat-square&labelColor=202b2d&color=b05275" alt="Clean commits"></a>
<a href="CONTRIBUTING.md#pull-requests">
<img src="https://img.shields.io/badge/PRs-welcome-0?style=flat-square&labelColor=202b2d&color=b05275" alt="PRs welcome"></a>
<a href="https://github.com/welpo/git-sumi/releases">
<img src="https://img.shields.io/github/v/release/welpo/git-sumi?style=flat-square&labelColor=202b2d&color=b05275" alt="Latest release"></a>
<a href="https://crates.io/crates/git-sumi">
<img src="https://img.shields.io/crates/v/git-sumi?style=flat-square&labelColor=202b2d&color=b05275" alt="Crates.io"></a>
<a href="https://codecov.io/gh/welpo/git-sumi">
<img src="https://img.shields.io/codecov/c/gh/welpo/git-sumi?style=flat-square&labelColor=202b2d&color=b05275" alt="Codecov"></a>
<br>
<a href="https://github.com/welpo/git-sumi/actions/workflows/ci.yml">
<img src="https://img.shields.io/github/actions/workflow/status/welpo/git-sumi/ci.yml?style=flat-square&labelColor=202b2d&color=b05275" alt="CI"></a>
<a href="https://github.com/welpo/git-sumi/actions/workflows/release.yml">
<img src="https://img.shields.io/github/actions/workflow/status/welpo/git-sumi/release.yml?style=flat-square&labelColor=202b2d&color=b05275&label=deploy" alt="Deployment"></a>
<a href="https://sumi.rs/docs">
<img src="https://img.shields.io/website?url=https%3A%2F%2Fsumi.rs&style=flat-square&label=docs&labelColor=202b2d&color=b05275" alt="Documentation"></a>
<a href="#-license">
<img src="https://img.shields.io/badge/license-MIT%20or%20Apache%202.0-0?style=flat-square&labelColor=202b2d&color=b05275" alt="MIT or Apache 2.0 License"></a>
</p>
<h4 align="center">
<a href="https://sumi.rs/docs">Documentation</a> |
<a href="https://sumi.rs">Website</a>
</h4>
<h1 align="center">git-sumi</h1>
<h3 align="center">The non-opinionated Rust-based commit message linter</h4>
Transform your commit practices with flexible linting for consistently high-quality Git commit messages that adhere to your project's standards.
> sumi (墨, /<span title="/s/: 's' in 'sigh'">s</span><span title="/ɯ/: like 'u' in 'flute', but unrounded">ɯ</span><span title="/m/: 'm' in 'my'">m</span><span title="/i/: 'i' in 'fleece'">i</span>/): ink, especially the type used in [traditional ink wash painting](https://en.wikipedia.org/wiki/Ink_wash_painting).
## 🎥 Demo
See how git-**sumi** can help you write better commit messages:
https://github.com/welpo/git-sumi/assets/6399341/1e21f237-0122-47e5-b79b-6972a0b9e23f
## ✨ Main features
- **Customizable rules**: Tailor git-**sumi** to each project's specific requirements. Easily configure [rules](https://sumi.rs/docs/rules/) to enforce [Conventional Commits](https://www.conventionalcommits.org/), length limits, gitmoji usage, and more through a [simple TOML file](https://sumi.rs/docs/configuration/).
- **Clear error reporting**: git-**sumi**'s detailed error reporting makes fixing commit messages straightforward and educational.
- **Seamless integration**: git-**sumi** is a [single binary](https://github.com/welpo/git-sumi/releases), making it easy to [integrate into your existing workflow](https://sumi.rs/docs/integration) with minimal setup.
## 📝 Documentation
Learn how to use git-**sumi** from the [documentation](https://sumi.rs/docs).
- [Quick setup](https://sumi.rs/docs/#quickstart)
- [Configuration](https://sumi.rs/docs/configuration)
- [Rules](https://sumi.rs/docs/rules)
- [Examples](https://sumi.rs/docs/examples)
- [Integration](https://sumi.rs/docs/integration)
- [Frequently Asked Questions](https://sumi.rs/docs/faq)
## 👥 Contributing
Please do! Contributions are always welcome. We appreciate improvements to the documentation, development of new rules, code cleanup, resolving issues, requesting or developing new functionality…
Take a look at our [Contributing Guidelines](/CONTRIBUTING.md) for more information on how to get started.
## 📄 License
This project is licensed under the terms of both the [MIT license](/LICENSE-MIT) and the [Apache License (Version 2.0)](/LICENSE-APACHE), at your option.
Raw data
{
"_id": null,
"home_page": "https://sumi.rs",
"name": "git-sumi",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "git,commit,lint,linter,rust,conventional commits",
"author": "\u00d3scar Fern\u00e1ndez <osc@osc.garden>",
"author_email": "\u00d3scar Fern\u00e1ndez <osc@osc.garden>",
"download_url": "https://files.pythonhosted.org/packages/27/ef/6f4468fc8719182799cfa0c769de5a051701f49283590a12b267fd9ef32d/git_sumi-0.0.8.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n <a href=\"https://sumi.rs\">\n <img src=\"https://raw.githubusercontent.com/welpo/git-sumi/main/website/static/img/logo.png\" width=\"300\" alt=\"git-sumi logo: a lantern held on a bamboo stick over the sea\">\n </a>\n <br><br>\n <a href=\"https://github.com/welpo/git-sumi\">\n <img src=\"https://img.shields.io/badge/clean_commits-git--sumi-0?style=flat-square&labelColor=202b2d&color=b05275\" alt=\"Clean commits\"></a>\n <a href=\"CONTRIBUTING.md#pull-requests\">\n <img src=\"https://img.shields.io/badge/PRs-welcome-0?style=flat-square&labelColor=202b2d&color=b05275\" alt=\"PRs welcome\"></a>\n <a href=\"https://github.com/welpo/git-sumi/releases\">\n <img src=\"https://img.shields.io/github/v/release/welpo/git-sumi?style=flat-square&labelColor=202b2d&color=b05275\" alt=\"Latest release\"></a>\n <a href=\"https://crates.io/crates/git-sumi\">\n <img src=\"https://img.shields.io/crates/v/git-sumi?style=flat-square&labelColor=202b2d&color=b05275\" alt=\"Crates.io\"></a>\n <a href=\"https://codecov.io/gh/welpo/git-sumi\">\n <img src=\"https://img.shields.io/codecov/c/gh/welpo/git-sumi?style=flat-square&labelColor=202b2d&color=b05275\" alt=\"Codecov\"></a>\n <br>\n <a href=\"https://github.com/welpo/git-sumi/actions/workflows/ci.yml\">\n <img src=\"https://img.shields.io/github/actions/workflow/status/welpo/git-sumi/ci.yml?style=flat-square&labelColor=202b2d&color=b05275\" alt=\"CI\"></a>\n <a href=\"https://github.com/welpo/git-sumi/actions/workflows/release.yml\">\n <img src=\"https://img.shields.io/github/actions/workflow/status/welpo/git-sumi/release.yml?style=flat-square&labelColor=202b2d&color=b05275&label=deploy\" alt=\"Deployment\"></a>\n <a href=\"https://sumi.rs/docs\">\n <img src=\"https://img.shields.io/website?url=https%3A%2F%2Fsumi.rs&style=flat-square&label=docs&labelColor=202b2d&color=b05275\" alt=\"Documentation\"></a>\n <a href=\"#-license\">\n <img src=\"https://img.shields.io/badge/license-MIT%20or%20Apache%202.0-0?style=flat-square&labelColor=202b2d&color=b05275\" alt=\"MIT or Apache 2.0 License\"></a>\n</p>\n\n<h4 align=\"center\">\n <a href=\"https://sumi.rs/docs\">Documentation</a> |\n <a href=\"https://sumi.rs\">Website</a>\n</h4>\n\n<h1 align=\"center\">git-sumi</h1>\n\n<h3 align=\"center\">The non-opinionated Rust-based commit message linter</h4>\n\nTransform your commit practices with flexible linting for consistently high-quality Git commit messages that adhere to your project's standards.\n\n> sumi (\u58a8, /<span title=\"/s/: 's' in 'sigh'\">s</span><span title=\"/\u026f/: like 'u' in 'flute', but unrounded\">\u026f</span><span title=\"/m/: 'm' in 'my'\">m</span><span title=\"/i/: 'i' in 'fleece'\">i</span>/): ink, especially the type used in [traditional ink wash painting](https://en.wikipedia.org/wiki/Ink_wash_painting).\n\n## \ud83c\udfa5 Demo\n\nSee how git-**sumi** can help you write better commit messages:\n\nhttps://github.com/welpo/git-sumi/assets/6399341/1e21f237-0122-47e5-b79b-6972a0b9e23f\n\n## \u2728 Main features\n\n- **Customizable rules**: Tailor git-**sumi** to each project's specific requirements. Easily configure [rules](https://sumi.rs/docs/rules/) to enforce [Conventional Commits](https://www.conventionalcommits.org/), length limits, gitmoji usage, and more through a [simple TOML file](https://sumi.rs/docs/configuration/).\n\n- **Clear error reporting**: git-**sumi**'s detailed error reporting makes fixing commit messages straightforward and educational.\n\n- **Seamless integration**: git-**sumi** is a [single binary](https://github.com/welpo/git-sumi/releases), making it easy to [integrate into your existing workflow](https://sumi.rs/docs/integration) with minimal setup.\n\n## \ud83d\udcdd Documentation\n\nLearn how to use git-**sumi** from the [documentation](https://sumi.rs/docs).\n\n- [Quick setup](https://sumi.rs/docs/#quickstart)\n- [Configuration](https://sumi.rs/docs/configuration)\n- [Rules](https://sumi.rs/docs/rules)\n- [Examples](https://sumi.rs/docs/examples)\n- [Integration](https://sumi.rs/docs/integration)\n- [Frequently Asked Questions](https://sumi.rs/docs/faq)\n\n## \ud83d\udc65 Contributing\n\nPlease do! Contributions are always welcome. We appreciate improvements to the documentation, development of new rules, code cleanup, resolving issues, requesting or developing new functionality\u2026\n\nTake a look at our [Contributing Guidelines](/CONTRIBUTING.md) for more information on how to get started.\n\n## \ud83d\udcc4 License\n\nThis project is licensed under the terms of both the [MIT license](/LICENSE-MIT) and the [Apache License (Version 2.0)](/LICENSE-APACHE), at your option.\n\n",
"bugtrack_url": null,
"license": "MIT OR Apache-2.0",
"summary": "The non-opinionated Rust-powered commit message linter",
"version": "0.0.8",
"project_urls": {
"Changelog": "https://github.com/welpo/git-sumi/blob/main/CHANGELOG.md",
"Documentation": "https://sumi.rs/docs/",
"Homepage": "https://sumi.rs",
"Repository": "https://github.com/welpo/git-sumi"
},
"split_keywords": [
"git",
"commit",
"lint",
"linter",
"rust",
"conventional commits"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "253d8effca32cd07bd3724956d7cdcf02f9da974abadf02cc2644e0355244ed5",
"md5": "778071b64d499305228d5c32c87f35fd",
"sha256": "118fa316a5f44d9ab3c5cdf46ad3b57777ed582f69f4c9bb6b584e46be084a70"
},
"downloads": -1,
"filename": "git_sumi-0.0.8-py3-none-macosx_10_12_x86_64.whl",
"has_sig": false,
"md5_digest": "778071b64d499305228d5c32c87f35fd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 1018485,
"upload_time": "2024-02-09T18:37:11",
"upload_time_iso_8601": "2024-02-09T18:37:11.474136Z",
"url": "https://files.pythonhosted.org/packages/25/3d/8effca32cd07bd3724956d7cdcf02f9da974abadf02cc2644e0355244ed5/git_sumi-0.0.8-py3-none-macosx_10_12_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "de95017fdd6f2922f94b1f06c2af6fa44fe646387358ac1945349f9d98b329a7",
"md5": "a41c545a0c0988b054762dc7ede2f85c",
"sha256": "9f402bf6c5bbf3e70b68e94efbef3ee71605789cb4e882d875733f14c0d65bfc"
},
"downloads": -1,
"filename": "git_sumi-0.0.8-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "a41c545a0c0988b054762dc7ede2f85c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 1099316,
"upload_time": "2024-02-09T18:37:13",
"upload_time_iso_8601": "2024-02-09T18:37:13.556453Z",
"url": "https://files.pythonhosted.org/packages/de/95/017fdd6f2922f94b1f06c2af6fa44fe646387358ac1945349f9d98b329a7/git_sumi-0.0.8-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "6e5d14fdd700fbc7450c21f3e714bd902d02792f6a4d96dd24bc85728647bad3",
"md5": "5df9b973cc5db45ca1edcbfedd57dcc5",
"sha256": "8f36048216b62c2a1251d9834dcc4bf97cd39f8ea0afc7c27e2f449ddea2875d"
},
"downloads": -1,
"filename": "git_sumi-0.0.8-py3-none-win_amd64.whl",
"has_sig": false,
"md5_digest": "5df9b973cc5db45ca1edcbfedd57dcc5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 977100,
"upload_time": "2024-02-09T18:37:15",
"upload_time_iso_8601": "2024-02-09T18:37:15.087621Z",
"url": "https://files.pythonhosted.org/packages/6e/5d/14fdd700fbc7450c21f3e714bd902d02792f6a4d96dd24bc85728647bad3/git_sumi-0.0.8-py3-none-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "27ef6f4468fc8719182799cfa0c769de5a051701f49283590a12b267fd9ef32d",
"md5": "23b72888cec2293730bf8619b27274ec",
"sha256": "29958d69f0b2c6b7bf8222aabc0b4cfa74611af7d6e62397ca5feebca04c9a62"
},
"downloads": -1,
"filename": "git_sumi-0.0.8.tar.gz",
"has_sig": false,
"md5_digest": "23b72888cec2293730bf8619b27274ec",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 39005,
"upload_time": "2024-02-09T18:37:17",
"upload_time_iso_8601": "2024-02-09T18:37:17.247721Z",
"url": "https://files.pythonhosted.org/packages/27/ef/6f4468fc8719182799cfa0c769de5a051701f49283590a12b267fd9ef32d/git_sumi-0.0.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-09 18:37:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "welpo",
"github_project": "git-sumi",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "git-sumi"
}
JSON
