Uploaded image for project: 'Data Management'
  1. Data Management
  2. DM-743

Checking for compliance to DM Standards should occur in a pre-commit hook and also be available on demand.

    Details

    • Team:
      SQuaRE

      Description

      Standards checking should be possible at multiple stages in the development cycle:
      1) in the user's local directory without the immediate intent of git-commit;
      2) in a pre-commit hook for all branches or, possibly, just the master branch.

      When standards checking is invoked, a report on the submitted code will be created and provided to a named file and/or email addresses.

      For the pre-commit hook, if the SAT determines that some Rules are serious enough to inhibit a commit, that constraint needs to be incorporated into the git-hook. (The current DM Coding Standards were developed primarily as advisory rules.)

      There are nuances which need to be considered for the git-hook:

      • should this be done on all branch commits or only the master branch;
      • are there any instances where the commit should be aborted.

        Attachments

          Issue Links

            Activity

            Hide
            swinbank John Swinbank added a comment -

            This has effectively been done thanks to widespread use of Travis/GitHub actions, plus setup.cfg files being available for developers to use their own linters.

            Show
            swinbank John Swinbank added a comment - This has effectively been done thanks to widespread use of Travis/GitHub actions, plus setup.cfg files being available for developers to use their own linters.

              People

              • Assignee:
                Unassigned
                Reporter:
                robyn Robyn Allsman [X] (Inactive)
                Watchers:
                John Swinbank, Robyn Allsman [X] (Inactive)
              • Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Summary Panel