From ba77e867ee90662cb40004af67fb0b1cf7310a9b Mon Sep 17 00:00:00 2001 From: beecave-orchestrator <261760907+beecave-orchestrator@users.noreply.github.com> Date: Sun, 5 Jul 2026 22:17:02 +0200 Subject: [PATCH] docs: distinguish file-path grouping types from prefix-only types Update the module-level docstring to clarify that DOCS, TEST, PERF, STYLE, BUILD, CI, and CHORE are selected via deterministic FILE_PATH_PATTERNS grouping, while FEAT, FIX, REFACTOR, and REVERT are prefix-only/heuristic types. Closes #87 --- git_acp/git/classification.py | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/git_acp/git/classification.py b/git_acp/git/classification.py index 4e1d188..c9e2b53 100644 --- a/git_acp/git/classification.py +++ b/git_acp/git/classification.py @@ -3,6 +3,15 @@ This module provides functionality for classifying commit types and analyzing changes in the repository to suggest appropriate commit types. +Recognized commit types: + FEAT, FIX, DOCS, STYLE, REFACTOR, TEST, CHORE, REVERT, BUILD, CI, PERF. + +Two selection mechanisms are used: + - Types with file-path grouping (deterministic, via ``FILE_PATH_PATTERNS``): + DOCS, TEST, PERF, STYLE, BUILD, CI, CHORE. + - Prefix-only types (detected from the conventional commit prefix): + FEAT, FIX, REFACTOR, REVERT. + Classification Priority: 1. Message prefix (e.g., "feat:", "fix:") - highest priority 2. File path patterns - deterministic and highly accurate