Feature-Discussion MCP Server

MIT License
Overview InspectNew Schema Related Servers Reviews Score
---
description: Automatically commit changes using conventional commits format
globs:
---
# Conventional Commits Rule

## Description
This rule defines the format and structure for commit messages following the Conventional Commits 1.0.0 specification. It ensures consistent, semantic, and machine-readable commit messages.

## Rule Type
workflow

## Rule Format
```json
{
  "type": "workflow",
  "name": "conventional_commits",
  "description": "Enforces Conventional Commits 1.0.0 specification",
  "filters": [
    {
      "type": "event",
      "pattern": "pre_commit"
    }
  ],
  "steps": [
    {
      "action": "validate",
      "description": "Validate commit message format",
      "requirements": [
        "Message MUST be prefixed with a type",
        "Type MUST be one of: feat, fix, docs, style, refactor, perf, test, build, ci, chore",
        "Scope is OPTIONAL and MUST be in parentheses",
        "Description MUST immediately follow the colon and space",
        "Description MUST use imperative mood ('add' not 'added')",
        "Description MUST be less than 100 characters",
        "Breaking changes MUST be indicated by '!' or 'BREAKING CHANGE:' footer",
        "Body MUST be separated from description by one blank line",
        "Footer MUST be separated from body by one blank line"
      ]
    },
    {
      "action": "execute",
      "description": "Format and create commit",
      "script": {
        "detect_type": {
          "feat": ["add", "create", "implement", "introduce"],
          "fix": ["fix", "correct", "resolve", "patch"],
          "docs": ["document", "comment", "update.*docs"],
          "style": ["style", "format", "lint"],
          "refactor": ["refactor", "restructure", "reorganize"],
          "perf": ["optimize", "performance", "improve.*speed"],
          "test": ["test", "spec", "coverage"],
          "build": ["build", "dependency", "package"],
          "ci": ["ci", "pipeline", "workflow"],
          "chore": ["chore", "misc", "task"]
        },
        "format_message": {
          "template": "${type}${scope}: ${description}\n\n${body}\n\n${footer}",
          "variables": {
            "type": "Detected from changes or user input",
            "scope": "Optional, derived from file paths",
            "description": "First line of commit message",
            "body": "Detailed explanation of changes",
            "footer": "Optional references or breaking changes"
          }
        },
        "command": [
          "# Extract type from changes or prompt user",
          "TYPE=$(detect_change_type \"$CHANGES\" || prompt_user \"Enter commit type:\")",
          "",
          "# Extract scope from file paths",
          "SCOPE=$(get_common_path \"$CHANGED_FILES\")",
          "",
          "# Format the commit message",
          "printf \"%s\\n\\n%s\\n\\n%s\" \"$TYPE${SCOPE:+($SCOPE)}: $DESCRIPTION\" \"$BODY\" \"$FOOTER\" > \"$COMMIT_MSG_FILE\""
        ]
      }
    }
  ]
}
```

## Manual Commit Syntax
When creating commits manually, always use the printf syntax to properly handle newlines and formatting:

```bash
printf "type(scope): description\n\nbody of the commit explaining the changes in detail\n\nfooter information" | git commit -F -
```

For example:
```bash
printf "feat(auth): add OAuth2 support\n\nAdd Google and GitHub provider integration\nImplement token refresh handling\nAdd user profile synchronization\n\nCloses #123" | git commit -F -
```

This ensures proper formatting and newline handling in the commit message.

## Examples

### Feature with Scope
```
feat(auth): implement OAuth2 support

- Add Google and GitHub provider integration
- Implement token refresh handling
- Add user profile synchronization

Closes #123
```

### Bug Fix with Breaking Change
```
fix(api): update user serialization

- Modify user data structure for better consistency
- Add validation for new fields

BREAKING CHANGE: user.fullName split into firstName and lastName
```

### Documentation Update
```
docs(readme): add modern package manager instructions

- Add yarn and pnpm installation methods
- Update minimum Node.js version requirement
```

### Performance Improvement
```
perf(core): optimize database queries

- Add query result caching
- Implement proper indexing
- Reduce unnecessary joins

Closes #456
```

## Integration
This rule should be used in conjunction with the git-commit-workflow rule to ensure changes are properly reviewed before creating the commit message. The workflow should be:

1. Review changes (git-commit-workflow)
2. Format commit message (conventional-commits)
3. Validate commit message (conventional-commits)
4. Commit changes