Skip to content

Provide an imperative mood check #256

@choeger

Description

@choeger

What's the problem this feature will solve?

Git commit message titles should be written in imperative mood. (Citation needed)

Describe the solution you'd like

There is a check like this over here, with a relatively heavyweight dependency:

https://github.com/dimaka-wix/commit-msg-hook/blob/59a706687cc53c526f25b5557b1144ba7e91cf23/src/main/cli.py#L223

seems easy enough to implement, but the dependency is heavy.

Rust has https://crates.io/crates/imperative - this has been migrated from here:

https://github.com/PyCQA/pydocstyle/blob/8d0cdfc93e86e096bb5753f07dc5c7c373e63837/src/pydocstyle/checker.py#L530

This does not come with a dependency but with a wordlist, e.g.,

https://github.com/crate-ci/imperative/blob/master/assets/imperatives.txt

I think that using a wordlist fits the style of this tool better.

Additional context

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions