Uploaded image for project: 'Moodle Community Sites'
  1. Moodle Community Sites
  2. MDLSITE-4418

Some Upgrade.txt guidelines

    XMLWordPrintable

    Details

    • Type: Task
    • Status: Open
    • Priority: Minor
    • Resolution: Unresolved
    • Component/s: Coding style
    • Labels:
      None

      Description

      There was an internal integrator discussion about this. We need to get it documented (hence creating this issue). But the general principle was

      1. Only document the relevant version in the upgrade.txt, not mixed branches

      Right

      master branch

      == 3.1 ==
      - Changed foo argument in bar
      

      MOODLE_30_STABLE

      == 3.0.2 ==
      - Changed foo argument in bar
      

      Wrong

      master branch

      == 3.1, 3.0.2, 2.9.7  ==
      - Changed foo argument in bar
      

      MOODLE_30_STABLE

      == 3.1, 3.0.2 ==
      - Changed foo argument in bar
      

      2. Only document relevant changes in third party library upgrades

      My proposal was:

      "Document any api changes in third party libraries which would impact developers. It is not necessarily to document an library upgrade when there is no notable api change or it is unlikely impact to Moodle plugins/customisations."

        Attachments

          Issue Links

            Activity

              People

              • Votes:
                0 Vote for this issue
                Watchers:
                3 Start watching this issue

                Dates

                • Created:
                  Updated: