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

CiBoT should check that all newly added database tables and columns have a comment

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Open
    • Priority: Minor
    • Resolution: Unresolved
    • Component/s: Integration
    • Labels:
      None

      Description

      We want to avoid issues like this:

      1. A developer is trying to understand the messaging changes in Moodle 3.5.
      2. They see that message_user_actions.action conitains values 1 or 2.
      3. They go to look in lib/db/install.php to see what this means.

      Acutal result: No info.

      Expect result: There should be a comment saying something like "1 = read, 2 = deleted, see core_message\api for the corresponding named constants."

      It should be possible to teach CiBoT to check that these comments are present, like it checks PHPdoc comments for completeness.

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              timhunt Tim Hunt
              Participants:
              Component watchers:
              Eloy Lafuente (stronk7)
            • Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

              Dates

              • Created:
                Updated: