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

Please include Git commit message guidelines in "setup and best practices" section of developer guide

    Details

      Description

      We currently provide some guidelines on "best practices" for commit messages in the development workflow documentation.

      However, we also provide a document on "Git Setup and Best Practices", which makes no reference to the above guidelines.

      It would be helpful to ensure that all our guidelines for git usage are available from the same location.

      (It would be even better if we could be clear about what's a requirement and what's a suggestion...)

        Attachments

          Issue Links

            Activity

            vpk24 Vishal Kasliwal [X] (Inactive) created issue -
            swinbank John Swinbank made changes -
            Field Original Value New Value
            Component/s Stack Documentation and UX [ 12880 ]
            Team SQuaRE [ 10302 ]
            Assignee Jonathan Sick [ jsick ]
            Description Please add commit message guidelines to the Git Best Practices section in the DM Developer Guide at http://developer.lsst.io/en/latest/tools/git_setup.html We currently provide some guidelines on ["best practices" for commit messages|http://developer.lsst.io/en/latest/processes/workflow.html#git-commit-message-best-practices] in the development workflow documentation.

            However, we also provide a document on ["Git Setup and Best Practices"|http://developer.lsst.io/en/latest/tools/git_setup.html], which makes no reference to the above guidelines.

            It would be helpful to ensure that all our guidelines for git usage are available from the same location.

            (It would be even better if we could be clear about what's a requirement and what's a suggestion...)
            Summary Add Git Commit Message Guidelines Please include Git commit message guidelines in "setup and best practices" section of developer guide
            jsick Jonathan Sick made changes -
            Assignee Jonathan Sick [ jsick ]
            jsick Jonathan Sick made changes -
            Epic Link DM-5403 [ 23210 ]
            jsick Jonathan Sick made changes -
            Labels dm-dev-guide
            jsick Jonathan Sick made changes -
            Story Points 0.1
            jsick Jonathan Sick made changes -
            Reviewers Vishal Kasliwal [ vpk24 ]
            Status To Do [ 10001 ] In Review [ 10004 ]
            vpk24 Vishal Kasliwal [X] (Inactive) made changes -
            Status In Review [ 10004 ] Reviewed [ 10101 ]
            jsick Jonathan Sick made changes -
            Link This issue relates to DM-5842 [ DM-5842 ]
            jsick Jonathan Sick made changes -
            Resolution Done [ 10000 ]
            Status Reviewed [ 10101 ] Done [ 10002 ]
            frossie Frossie Economou made changes -
            Epic Link DM-5403 [ 23210 ] DM-6198 [ 24714 ]

              People

              • Assignee:
                jsick Jonathan Sick
                Reporter:
                vpk24 Vishal Kasliwal [X] (Inactive)
                Reviewers:
                Vishal Kasliwal [X] (Inactive)
                Watchers:
                John Swinbank, Jonathan Sick, Vishal Kasliwal [X] (Inactive)
              • Votes:
                0 Vote for this issue
                Watchers:
                3 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Summary Panel