Skip to content

[DOC] contribution guide: clarify commit prefixes + work-file annotations - #5678

Closed
dnplkndll wants to merge 2 commits into
OCA:documentationfrom
ledoent:doc/contribution-guide-clarity
Closed

[DOC] contribution guide: clarify commit prefixes + work-file annotations#5678
dnplkndll wants to merge 2 commits into
OCA:documentationfrom
ledoent:doc/contribution-guide-clarity

Conversation

@dnplkndll

Copy link
Copy Markdown
Contributor

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.
  • Work-file annotations go inline, one per analysis line; empty sections (a ---<Type> in module 'X'--- header with no lines under it) get no marker — left blank.

Brand-name capitalizationOpenupgradeOpenUpgrade, odooOdoo across four narrative files.

Source-only: docs/ is regenerated by the documentation-commit workflow on push.

dnplkndll added 2 commits May 30, 2026 14:15
- [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
dnplkndll force-pushed the doc/contribution-guide-clarity branch from 144f7e4 to ef96e12 Compare May 30, 2026 18:15
@pedrobaeza

Copy link
Copy Markdown
Member

@legalsylvain why closing the PR? One of the commits is correct about the upcasing, and the other to check (it would be good though to have them split).

@dnplkndll

Copy link
Copy Markdown
Contributor Author

I was trying to codify the conflicting advice I have gotten from PR reviews.

@hbrunn

hbrunn commented Jun 3, 2026

Copy link
Copy Markdown
Member

I was of a mind doing the same (closing all PRs by the contributor unread) because spamming a repo with 30+ unsupervised bullshit generator generated PRs and let the reviewers sort it out is not okay behavior.

Unfortunately, we don't yet have a policy I can point to, so I grudgingly refrain from doing so for now and fend off the bullshit as time permits.

@dnplkndll

Copy link
Copy Markdown
Contributor Author

@hbrunn I have tried my best to learn the conventions of this repo. watched the videos read the docs, do my best to provide work of value. if I was out of line in thinking I could manage to review more material than I should have, then I apologize. but there is nothing unsupervised. yes I have never contributed to this database migration module but I have written extensive erp DB migration in general.

I will only try to ask minimal questions an learn from watching the community accepted versions of the migration attempts I have done and hope to learn for a better experience next season.

The effort to know how to handle the assisted contributions is real and I feel your pain. just want to clarify I am not some flyover and have ever intent to add value and move the needle on the community value to end users that need paths to new versions in a reasonable timeframe.

@legalsylvain

Copy link
Copy Markdown
Contributor

Hi @dnplkndll.

thanks for your answer.

The effort to know how to handle the assisted contributions is real and I feel your pain.

Just to understand : if you understand the problems generated by your use of the AI, why not stop to use it ? you are welcome in the OpenUpgrade project, and we will try to take a time to help you. but AI are not welcome !

Thanks !

@pedrobaeza

Copy link
Copy Markdown
Member

@dnplkndll you can resubmit the casing PR, and the other is worth to explore it.

@dnplkndll

Copy link
Copy Markdown
Contributor Author

@legalsylvain

Just to understand : if you understand the problems generated by your use of the AI, why not stop to use it ?

My situation has changed and I no longer have a team to help do the research on solutions. So I have the AI research solutions and look for impacts in performance and try to test, reduce the complexity, ... all kinds of skills and directives which observed on occation.

I have researched and looked for ways to mitigate the impact of too much being delegated and actually want to learn the codebase. But models and harnesses will improve. So any experience I can gain in the review, notes, skill building is still what I need to grow as well as actual codebase understanding. However I understand that it is at the expense of maintainers/reviewers and need to do a better job of helping where there is a need versus starting pet projects that are interesting to me.

Again I apologize and hope over time I can still build contributions of value. thanks for the feedback.

@legalsylvain

Copy link
Copy Markdown
Contributor

My situation has changed and I no longer have a team to help do the research on solutions.

If you face difficulties, you can ask to OCA members, or take a look on OCA ressources. Working alongside other human is very enjoyable.

Regards.

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.

4 participants