[DOC] contribution guide: clarify commit prefixes + work-file annotations#5678
Open
dnplkndll wants to merge 2 commits into
Open
[DOC] contribution guide: clarify commit prefixes + work-file annotations#5678dnplkndll wants to merge 2 commits into
dnplkndll wants to merge 2 commits into
Conversation
This was referenced May 30, 2026
- [MIG] <module> is the standard prefix for a module's whole migration (annotations and/or scripts); [OU-ADD]/[OU-FIX]/[OU-IMP] are for framework/cross-cutting changes. Fixes the stale [ADD] example. - Work-file annotations go inline per analysis line; empty sections (header with no lines) get no marker.
dnplkndll
force-pushed
the
doc/contribution-guide-clarity
branch
from
144f7e4 to
ef96e12
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Two small clarifications to the contribution guide, plus a brand-consistency pass.
090_contribute.rst[MIG] <module>is the standard prefix for a module's whole migration (analysis annotations and/or pre/post scripts). The previous text implied[ADD]/[OU-ADD]; recent 19.0 history is overwhelmingly[MIG](used with and without scripts), with[OU-ADD]/[OU-FIX]/[OU-IMP]reserved for framework / cross-cutting changes.---<Type> in module 'X'---header with no lines under it) get no marker — left blank.Brand-name capitalization —
Openupgrade→OpenUpgrade,odoo→Odooacross four narrative files.Source-only:
docs/is regenerated by the documentation-commit workflow on push.