Back to Freecodecamp

Task 41

curriculum/challenges/english/blocks/learn-how-to-document-code-for-a-project/65e99595bee9924f07b5abc3.md

latest2.3 KB
Original Source
<!-- (Audio) Brian: Good question. When you make changes, you should use descriptive commit messages. Start your message with a verb in the imperative form, like `Fix`, `Add`, or `Update`, followed by a brief description of what you did. -->

--description--

Listen to the audio and answer the question.

--questions--

--text--

What does Brian suggest about writing commit messages?

--answers--

Always ask for approval before committing changes.

--feedback--

Brian's advice is about how to write commit messages, not about seeking approval for the changes.


Use descriptive messages starting with an imperative verb, followed by a brief description of the changes.


Write a long and detailed report for each change.

--feedback--

Brian recommends a brief description, not a long and detailed report, for the commit messages.


Avoid using verbs in commit messages.

--feedback--

Brian actually suggests starting commit messages with a verb in the imperative form.

--video-solution--

2

--scene--

json
{
  "setup": {
    "background": "company2-center.png",
    "characters": [
      {
        "character": "Brian",
        "position": {
          "x": 50,
          "y": 15,
          "z": 1.2
        },
        "opacity": 0
      }
    ],
    "audio": {
      "filename": "7.1-3.mp3",
      "startTime": 1,
      "startTimestamp": 6.6,
      "finishTimestamp": 19.7
    }
  },
  "commands": [
    {
      "character": "Brian",
      "opacity": 1,
      "startTime": 0
    },
    {
      "character": "Brian",
      "startTime": 1,
      "finishTime": 5.4,
      "dialogue": {
        "text": "Good question. When you make changes, you should use descriptive commit messages.",
        "align": "center"
      }
    },
    {
      "character": "Brian",
      "startTime": 5.84,
      "finishTime": 8.5,
      "dialogue": {
        "text": "Start your message with a verb in the imperative form",
        "align": "center"
      }
    },
    {
      "character": "Brian",
      "startTime": 8.5,
      "finishTime": 14.1,
      "dialogue": {
        "text": "like fix, add, or update followed by a brief description of what you did.",
        "align": "center"
      }
    },
    {
      "character": "Brian",
      "opacity": 0,
      "startTime": 14.6
    }
  ]
}