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

Clearly state what Git commit message and organization workflows are requirements/recommendations

    Details

      Description

      The Developer Guide’s Workflow document includes appendices on how best to use Git: including advice on how best to organize commits and how to structure commit messages.

      In DM-5826 John Swinbank pointed how that these appendices can be misleading since they suggest that some advice are requirements, when in fact they may not be:

      At the moment, we simply have a statement that "we follow" some particular set of guidelines. My concern is simply that we don't, or at least we're not required to. Softening the language to "we suggest", or similar, instead would resolve the issue as far as I'm concerned.

      This ticket will

      1. Determine what parts of those appendices may be requirements, if any.
      2. Change the language to intentionally differentiate between suggestions and requirements (“we follow” or “we require")

        Attachments

          Issue Links

            Activity

            There are no comments yet on this issue.

              People

              • Assignee:
                jsick Jonathan Sick
                Reporter:
                jsick Jonathan Sick
                Watchers:
                Jonathan Sick
              • Votes:
                0 Vote for this issue
                Watchers:
                1 Start watching this issue

                Dates

                • Created:
                  Updated:

                  Summary Panel