From 855964d41a94ceab1c0e695c0765154a7b2958a5 Mon Sep 17 00:00:00 2001 From: Sylvain LE GAL Date: Fri, 17 Nov 2023 00:38:03 +0100 Subject: [PATCH] [IMP] contribute section, taking into account reviewers remarks --- docsource/090_contribute.rst | 30 +++++++++++++++++++++++++----- 1 file changed, 25 insertions(+), 5 deletions(-) diff --git a/docsource/090_contribute.rst b/docsource/090_contribute.rst index 5a6f776c9d16..a7b16357ef5b 100644 --- a/docsource/090_contribute.rst +++ b/docsource/090_contribute.rst @@ -40,16 +40,37 @@ module from version 15.0 to version 16.0: ``cp upgrade_analysis.txt upgrade_analysis_work.txt`` * Explain the changes to do in the ``upgrade_analysis_work.txt``. - 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`) + 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.`) * Finally, commit your changes. ``git add . && git commit -am "[OU-ADD] account"`` (For a fix, use ``[OU-FIX]`` prefix) * Propose your changes to the community for review. - ``git push MY_REMOTE 16.0-mig-account`` + + * ``git push MY_REMOTE 16.0-mig-account`` + + * Open a Pull Request on github Community involvement --------------------- @@ -81,4 +102,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! -