octue / generate-pull-request-description

A GitHub action that updates PR descriptions from Conventional Commits
9 stars 7 forks source link

Does not Follow Conventional Commits Spec #7

Open akovalov opened 1 year ago

akovalov commented 1 year ago

It does not follow the latest v1.0.0 conventional commits types.

From the code, it supports the following types:

COMMIT_CODES_TO_HEADINGS_MAPPING = {
    "FEA": "### New features",
    "ENH": "### Enhancements",
    "FIX": "### Fixes",
    "OPS": "### Operations",
    "DEP": "### Dependencies",
    "REF": "### Refactoring",
    "TST": "### Testing",
    "MRG": OTHER_SECTION_HEADING,
    "REV": "### Reversions",
    "CHO": "### Chores",
    "STY": "### Style",
    "WIP": OTHER_SECTION_HEADING,
    "DOC": OTHER_SECTION_HEADING,
}

But the conventional commits specification have different types and lowercased.

Other than that, it works great! Thank you for your efforts!

DeutscheGabanna commented 1 month ago

Also, it does not properly categorise commits with [scope]. The specification says this is allowed:

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]