Back to Freecodecamp

Task 40

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

latest1.8 KB
Original Source
<!-- (Audio) Brian: 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--

The imperative form is a command or instruction. For example, Close the door.

Brief means short and to the point. For instance, He gave a brief explanation.

--fillInTheBlank--

--sentence--

Start your message with a verb in the BLANK form, like "Fix", "Add", or "Update", followed by a BLANK description of what you BLANK.

--blanks--

imperative

--feedback--

It refers to giving a command or instruction. Brian suggests starting commit messages with a command-like verb.


brief

--feedback--

It means short and concise. Brian advises keeping the description of the action succinct.


did

--feedback--

This word is used to refer to the action that was completed. Brian is talking about describing what action was done in the code.

--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": 11.24,
      "finishTimestamp": 19.7
    }
  },
  "commands": [
    {
      "character": "Brian",
      "opacity": 1,
      "startTime": 0
    },
    {
      "character": "Brian",
      "startTime": 1,
      "finishTime": 9.46,
      "dialogue": {
        "text": "Start your message with a verb in the imperative form like fix, add, or update followed by a brief description of what you did.",
        "align": "center"
      }
    },
    {
      "character": "Brian",
      "opacity": 0,
      "startTime": 9.96
    }
  ]
}