Skip to content

[DOC] 090_contribute: document [MIG] prefix; clarify [OU-*]#40

Closed
dnplkndll wants to merge 1 commit into
documentationfrom
doc/commit-prefix-guidance
Closed

[DOC] 090_contribute: document [MIG] prefix; clarify [OU-*]#40
dnplkndll wants to merge 1 commit into
documentationfrom
doc/commit-prefix-guidance

Conversation

@dnplkndll
Copy link
Copy Markdown

What

Updates `docsource/090_contribute.rst` to match the prefix pattern observed on the current 19.0 branch:

  • Replace the example commit `[ADD] account` → `[MIG] account` (`[MIG]` is now the dominant prefix for first-pass migration scripts)
  • Add a Note entry naming `[MIG]` explicitly as "first-pass migration script for a module version"
  • Reframe the `[OU-*]` entry from "V13 and before only" to "framework, infrastructure, or cross-cutting helpers". The prefixes originated in the V13-fork era but remain in use today for framework-level work (e.g. recent `[OU-IMP] stock_picking_show_return: Merged into stock`, `[OU-FIX] don't fail when there's an unknown field in a view`)

Evidence

Prefix histogram across the last 200 commits on `origin/19.0`:

Prefix Count Used for
`[MIG]` 58 First-pass module migration script (dominant)
`[IMP]` 27 Improving existing scripts or framework
`[FIX]` 20 Fixing existing scripts or framework
`[UPD]` 14 Update-style commits
`[OU-IMP]` / `[OU-FIX]` / `[OU-ADD]` 9 total Framework / infrastructure (not module migrations)
`[BOT]` 5 Auto-generated
`[REF]` 2 Refactor
`[DOC]` 1 Documentation
`[ADD]` 1 (mostly bot-generated `[IMP] Update analysis files` — not human-authored migration scripts)

The existing guide's `[ADD]` example contradicts the practice; the `[OU-*]` "V13 and before" framing under-sells where the prefix is actually used.

Scope

Draft, fork-only for review. If you sign off, this is a clean candidate to propose upstream against `OCA/OpenUpgrade:documentation` — small, observable from a single `git log` command, no behavioural change.

Companion PR for the annotation-grouping note is opened as a separate diff.

The current guide shows ``[ADD] account`` in the example and lists
``[FIX]`` / ``[IMP]`` / ``[OU-*]`` in the Note. Recent branches use
``[MIG]`` as the dominant prefix for first-pass module migration
scripts (e.g. ``[MIG] account``, ``[MIG] hr_recruitment``); ``[ADD]``
is now used almost exclusively by the analysis bot. ``[OU-*]`` is
used for framework-level changes rather than only "V13 and before".

Update the example and the Note to match the prefix pattern observed
on the 19.0 branch (last 200 commits: 58 ``[MIG]``, 27 ``[IMP]``,
20 ``[FIX]``, 9 ``[OU-*]``, 1 ``[ADD]``).
@dnplkndll
Copy link
Copy Markdown
Author

Superseded by the consolidated upstream PR OCA#5678. Branch kept.

@dnplkndll dnplkndll closed this May 30, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant