К основному содержанию
правило

git-conventional-commit-messages — правило для Cursor: установка

Правило задаёт формат Conventional Commits для сообщений Git. Пригодится, когда агент готовит коммиты по типу изменения и области кода.

Установить в Cursor · Вручную: положить файлы Все способы и платформы ↓
.cursor/rules/git-conventional-commit-messages.mdc
Открыть на GitHub

Что делает git-conventional-commit-messages

Правило просит Cursor оформлять сообщения Git по схеме Conventional Commits: тип, необязательная область в скобках и описание после двоеточия. Для длинных изменений можно добавить тело и футеры через пустые строки.

Типы feat и fix связываются с новыми функциями и исправлениями ошибок. Допустимы build, chore, ci, docs, style, refactor, perf, test и другие. Несовместимое изменение отмечается ! перед двоеточием или футером BREAKING CHANGE:.

Создайте файл правила по пути .cursor/rules/git-conventional-commit-messages.mdc без пробела после обратной кавычки. В правиле указано alwaysApply: false, поэтому оно не относится к постоянно применяемым правилам Cursor.

Какие задачи решает

  • сформировать сообщение коммита по Conventional Commits
  • выбрать тип для новой функции или исправления
  • добавить область кода в заголовок коммита
  • отметить breaking change в префиксе или футере

Примеры запросов агенту

  • Сформируй сообщение коммита для добавления авторизации и выбери подходящий тип.
  • Оформи коммит для исправления парсинга в области parser.
  • Запиши breaking change в формате Conventional Commits с футером BREAKING CHANGE:.

Как установить git-conventional-commit-messages

Вручную: положить файлы

.cursor/rules/git-conventional-commit-messages.mdc

Во frontmatter: description, globs, alwaysApply

По шагам, с командами для каждой платформы: Cursor rules: файлы .mdc, четыре режима и замена .cursorrules

Вопросы о git-conventional-commit-messages

Как установить git-conventional-commit-messages в Cursor?

Создайте файл .cursor/rules/git-conventional-commit-messages.mdc без пробела после обратной кавычки и добавьте в него содержимое правила.

Что делает git-conventional-commit-messages?

Правило задаёт структуру сообщений Git: тип, область, описание, тело и футеры. Оно также объясняет оформление feat, fix и несовместимых изменений.

Как обозначить breaking change?

Используйте ! перед двоеточием в префиксе или добавьте футер BREAKING CHANGE: с описанием изменения.

Исходный текст

git-conventional-commit-messages.mdc · CC0-1.0
---
description: "Cursor rules for Git development with conventional commit messages integration."
globs: **/*
alwaysApply: false
---
Use the Conventional Commit Messages specification to generate commit messages

The commit message should be structured as follows:


```
<type>[optional scope]: <description>

[optional body]

[optional footer(s)]
``` 
--------------------------------

The commit contains the following structural elements, to communicate intent to the consumers of your library:

  - fix: a commit of the type fix patches a bug in your codebase (this correlates with PATCH in Semantic Versioning).
  - feat: a commit of the type feat introduces a new feature to the codebase (this correlates with MINOR in Semantic Versioning).
  - BREAKING CHANGE: a commit that has a footer BREAKING CHANGE:, or appends a ! after the type/scope, introduces a breaking API change (correlating with MAJOR in Semantic Versioning). A BREAKING CHANGE can be part of commits of any type.
  - types other than fix: and feat: are allowed, for example @commitlint/config-conventional (based on the Angular convention) recommends build:, chore:, ci:, docs:, style:, refactor:, perf:, test:, and others.
  - footers other than BREAKING CHANGE: <description> may be provided and follow a convention similar to git trailer format.
  - Additional types are not mandated by the Conventional Commits specification, and have no implicit effect in Semantic Versioning (unless they include a BREAKING CHANGE). A scope may be provided to a commit’s type, to provide additional contextual information and is contained within parenthesis, e.g., feat(parser): add ability to parse arrays.



### Specification Details

The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in RFC 2119.

Commits MUST be prefixed with a type, which consists of a noun, feat, fix, etc., followed by the OPTIONAL scope, OPTIONAL !, and REQUIRED terminal colon and space.
The type feat MUST be used when a commit adds a new feature to your application or library.
The type fix MUST be used when a commit represents a bug fix for your application.
A scope MAY be provided after a type. A scope MUST consist of a noun describing a section of the codebase surrounded by parenthesis, e.g., fix(parser):
A description MUST immediately follow the colon and space after the type/scope prefix. The description is a short summary of the code changes, e.g., fix: array parsing issue when multiple spaces were contained in string.
A longer commit body MAY be provided after the short description, providing additional contextual information about the code changes. The body MUST begin one blank line after the description.
A commit body is free-form and MAY consist of any number of newline separated paragraphs.
One or more footers MAY be provided one blank line after the body. Each footer MUST consist of a word token, followed by either a :<space> or <space># separator, followed by a string value (this is inspired by the git trailer convention).
A footer’s token MUST use - in place of whitespace characters, e.g., Acked-by (this helps differentiate the footer section from a multi-paragraph body). An exception is made for BREAKING CHANGE, which MAY also be used as a token.
A footer’s value MAY contain spaces and newlines, and parsing MUST terminate when the next valid footer token/separator pair is observed.
Breaking changes MUST be indicated in the type/scope prefix of a commit, or as an entry in the footer.
If included as a footer, a breaking change MUST consist of the uppercase text BREAKING CHANGE, followed by a colon, space, and description, e.g., BREAKING CHANGE: environment variables now take precedence over config files.
If included in the type/scope prefix, breaking changes MUST be indicated by a ! immediately before the :. If ! is used, BREAKING CHANGE: MAY be omitted from the footer section, and the commit description SHALL be used to describe the breaking change.
Types other than feat and fix MAY be used in your commit messages, e.g., docs: update ref docs.
The units of information that make up Conventional Commits MUST NOT be treated as case sensitive by implementors, with the exception of BREAKING CHANGE which MUST be uppercase.
BREAKING-CHANGE MUST be synonymous with BREAKING CHANGE, when used as a token in a footer.

© PatrickJS · CC0-1.0 · PatrickJS/awesome-cursorrules

Похожие правила IDE

Всё по теме «Git и GitHub» →
update-docs-on-code-change официальный github Правило для GitHub Copilot, которое напоминает обновлять README.md и документацию, когда меняется код. Пригодится, если доки у вас отстают от реальности. ★ 40 451звёзд репо markdown-gfm официальный github Правило задаёт Copilot синтаксис GitHub Flavored Markdown, когда он пишет или проверяет файлы .md. Пригодится, если документация должна проходить рендер на GitHub без сюрпризов. ★ 40 451звёзд репо instructions официальный github Свод правил и структура для создания качественных файлов инструкций Copilot с привязкой по glob-маскам. ★ 40 451звёзд репо hooks официальный github Правило-инструкция для GitHub Copilot о том, как писать хуки: конфиг в .github/hooks/, скрипты на Bash и PowerShell, коды выхода и запрет действий. ★ 40 451звёзд репо github-actions-ci-cd-best-practices официальный github Правило для GitHub Copilot: подсказывает структуру workflow, работу с секретами, кэшем и матрицами при правке файлов в .github/workflows/. ★ 40 451звёзд репо copilot-thought-logging официальный github Правило заставляет Copilot вести файл Copilot-Processing.md с планом и отметками о выполнении, чтобы вы видели ход работы и могли его поправить. ★ 40 451звёзд репо

Из того же набора140

go-servemux-rest-api-cursorrules-prompt-file Правило для Cursor, которое настраивает ассистента писать REST API на Go через net/http и новый ServeMux из Go 1.22. ★ 41 024звёзд репо github-cursorrules-prompt-file-instructions Правило направляет Cursor к читаемому и поддерживаемому коду: осмысленным именам, коротким функциям и понятным комментариям. ★ 41 024звёзд репо github-code-quality-cursorrules-prompt-file Набор ограничений для агента Cursor: он проверяет факты перед выводом, не тратит ответ на извинения и сводки, правит файлы по одному. ★ 41 024звёзд репо gitflow Задаёт правила ветвления Gitflow, формат коммитов Conventional Commits и порядок релизов для ИИ-ассистента в Cursor. ★ 41 024звёзд репо gherkin-style-testing-cursorrules-prompt-file Правило превращает технические тест-скрипты и ручные кейсы в Gherkin-сценарии на языке, понятном бизнесу и юристам. ★ 41 024звёзд репо gamemaker-gml Задаёт стандарты архитектуры и стиля GameMaker Language для проектов на GML. Помогает Cursor писать чистый игровой код без утечек памяти. ★ 41 024звёзд репо fortran Правило задаёт стиль для современного Fortran: модули, типы, массивы, тесты и сборка. Оно пригодится при разработке научного кода в Cursor. ★ 41 024звёзд репо flutter-development-guidelines-cursorrules-prompt-file Задаёт структуру проекта, нейминг и стиль Dart для Flutter-приложений на MVVM с Riverpod. Пригодится, когда агент в Cursor разносит код по папкам как попало. ★ 41 024звёзд репо

Спонсоры проекта

Компании, которые помогают держать аналитику открытой