Merge pull request #4227 from legalsylvain/documentation-contribute

[DOC] Describe how to propose a migration script to the community.

docsource/090_contribute.rst

@@ -10,6 +10,85 @@ In order to contribute to the OpenUpgrade project, please
   database, and give back any code improvements developed during the project.
 
 
+How to contribute new migration scripts
+---------------------------------------
+
+To Contribute to OpenUpgrade you must make one pull request per module.
+
+For example, if you want to propose the migration script of the ``account``
+module from version 15.0 to version 16.0:
+
+  * Always ensure that there is no work already in progress by a community member.
+    For that purpose, go the issue named "Migration to version NN.0" on GitHub, where NN is the version for which you want to propose the script.
+    `here <https://github.com/OCA/OpenUpgrade/issues?q=is%3Aopen++is%3Aissue+%22Migration+to+version%22+/>`_.
+
+    Sometimes, the pull request is not yet registered in the issue, so it's not bad to do a search on the opened pull requests with the name of the module to look for.
+
+  * Then, ensure that all the dependencies of the module are mark as ``done`` or
+    ``Nothing to do`` in OpenUpgrade for that version.
+    For that purpose, refer to :doc:`030_coverage_analysis`.
+    In our example, check the ``depends`` key of the `manifest <https://github.com/odoo/odoo/blob/16.0/addons/account/__manifest__.py#L18>`_ of the ``account`` module 
+    If some dependencies are missing, you should start by migrating these modules.
+
+**Note**
+
+It's not strictly necessary to make contributions in the order of dependency,
+but you may face errors that are not related to your contribution, if you don't follow this order.
+For example, the sale_stock migration script may fail, if the stock migration script has not been run upstream.
+
+  * As other OCA contribution, create a new branch, from an up to date OCA branch:
+
+  .. code-block:: shell
+
+     git checkout -b 16.0-mig-account
+
+  * Make a copy of the analysis file with the suffix ``_work``.
+
+  .. code-block:: shell
+
+     cd ./openupgrade_scripts/scripts/account/16.0.1.2/
+     cp upgrade_analysis.txt upgrade_analysis_work.txt
+
+
+  * Explain the changes to do in the ``upgrade_analysis_work.txt``.
+    For each line, add a prefix, and explain your analysis:
+
+    * ``NOTHING TO DO``, and why it's nothing to do
+    * ``DONE``: pre-migration/post-migration: indicating the what and maybe the why.
+    * ``TODO``: This shouldn't be usually done.
+
+**Note:**
+You can reorder lines and group them together for including all of them in a "logical" block for putting only one comment.
+Examples: all the noupdate=0 new and del ir* records, or the NEW and DEL lines for a field that is renamed.
+
+  * Write ``pre-migration.py`` and / or ``post-migration.py`` scripts in the same folder.
+
+  * Comment / uncomment lines in ``noupdate_changes.xml``.
+
+(Read more in :doc:`080_migration_script_development`)
+
+  * Finally, update the coverage file in ``docsource/modulesXX-YY.rst``, and mark the
+    module as ``done``, ``Nothing to do``, etc.
+
+(Read more in :doc:`coverage legend detail.<coverage_analysis/coverage_legend>`)
+
+  * Finally, commit and push your changes.
+
+  .. code-block:: shell
+
+      git add .
+      git commit -am "[OU-ADD] account"
+      git push MY_REMOTE 16.0-mig-account
+
+
+  **Note:**
+
+    * For a fix of an existing migration scripts, use ``[OU-FIX]``
+
+    * For an improvement of an existing migration scripts, use ``[OU-IMP]``
+
+  * Propose your changes to the community for review, opening a Pull Request on github.
+
 Community involvement
 ---------------------
 
@@ -40,4 +119,3 @@ project covers the modules that you have in use, try and use the software
 to upgrade a copy of your database and give us feedback.
 
 Thank you!
-