[DOC] contribution guide: clarify prefixes, work-file annotations, brand consistency#88
Closed
dnplkndll wants to merge 2 commits into
Closed
[DOC] contribution guide: clarify prefixes, work-file annotations, brand consistency#88dnplkndll wants to merge 2 commits into
dnplkndll wants to merge 2 commits into
Conversation
- [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.
Author
|
Superseded by the consolidated upstream PR OCA#5678. Branch kept. |
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.
One consolidated, source-only docs PR — supersedes the three split fork PRs (#40 prefixes, #41 annotations, #42 caps).
Two commits:
090_contribute—[MIG] <module>is the standard per-module migration prefix (annotations and/or scripts; verified against 16[MIG]commits on 19.0 — used with and without scripts);[OU-*]is framework/cross-cutting only. Work-file annotations go inline per analysis line; empty sections get no marker (hbrunn [19.0][MIG] account_*: analysis annotations for simple submodules OCA/OpenUpgrade#5647; confirmed by real merged work files, e.g. phone_validation's empty---Models---section).Source-only — no
docs/*.html; thedocumentation-commitbot regenerates those on push (the split PRs each committed 40+ generated HTML files — dropped here). Verified: no new sphinx warnings in the changed files.