Uploaded image for project: 'Qt Quality Assurance Infrastructure'
  1. Qt Quality Assurance Infrastructure
  2. QTQAINFRA-1478

Sanity bot should provide more hints for new users

    XMLWordPrintable

    Details

    • Type: Suggestion
    • Status: Open
    • Priority: P2: Important
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: Sanity Bot
    • Labels:
      None

      Description

      Currently we have, for example:

      where new contributors are confronted with the sanity bot's error message and may feel a bit lost. As a reviewer, I have extra work explaining them how to fix the message.

      The bot could already contain some hints or provide a link to a website with more explanations.

      E.g.: for "2nd line not empty":

      Patch summary in one short line followed by an empty line
      
      Detailed patch description follows separated by an empty line.
      This can stretch multiple lines and often contains [ChangeLog]
      entries.

      or "URL pointing to Gerrit or JIRA":

      Patch summary in one short line
      
      Please do not use links to JIRA in commit messages. The bug is 
      referenced by a "Task-number" line at the commit message bottom, 
      directly above the Change-Id line:
      
      Task-number: QTBUG-12345
      Change-Id: xyz

        Attachments

        No reviews matched the request. Check your Options in the drop-down menu of this sections header.

          Activity

            People

            Assignee:
            Eddy Edward Welbourne
            Reporter:
            aha_1980 André Hartmann
            Votes:
            0 Vote for this issue
            Watchers:
            6 Start watching this issue

              Dates

              Created:
              Updated:

                Gerrit Reviews

                There are no open Gerrit changes