Back to Freecodecamp

Dialogue 3: Version Control and Documenting Changes

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

latest3.2 KB
Original Source

--description--

Watch the video to understand the context of the upcoming lessons.

--assignment--

Watch the video

--scene--

json
{
  "setup": {
    "background": "company2-center.png",
    "characters": [
      {
        "character": "Sophie",
        "position": { "x": -25, "y": 0, "z": 1 }
      },
      {
        "character": "Brian",
        "position": { "x": 125, "y": 0, "z": 1 }
      }
    ],
    "audio": {
      "filename": "7.1-3.mp3",
      "startTime": 1
    },
    "alwaysShowDialogue": true
  },
  "commands": [
    {
      "character": "Sophie",
      "position": { "x": 25, "y": 0, "z": 1 },
      "startTime": 0
    },
    {
      "character": "Brian",
      "position": { "x": 70, "y": 0, "z": 1 },
      "startTime": 0.5
    },
    {
      "character": "Sophie",
      "startTime": 1,
      "finishTime": 3.4,
      "dialogue": {
        "text": "I see that we're using Git for version control.",
        "align": "left"
      }
    },
    {
      "character": "Sophie",
      "startTime": 3.92,
      "finishTime": 6.9,
      "dialogue": {
        "text": "How do I document code changes when I make updates or fixes?",
        "align": "left"
      }
    },
    {
      "character": "Brian",
      "startTime": 7.6,
      "finishTime": 12,
      "dialogue": {
        "text": "Good question. When you make changes, you should use descriptive commit messages.",
        "align": "right"
      }
    },
    {
      "character": "Brian",
      "startTime": 12.44,
      "finishTime": 15.1,
      "dialogue": {
        "text": "Start your message with a verb in the imperative form",
        "align": "right"
      }
    },
    {
      "character": "Brian",
      "startTime": 15.1,
      "finishTime": 20.7,
      "dialogue": {
        "text": "like fix, add, or update followed by a brief description of what you did.",
        "align": "right"
      }
    },
    {
      "character": "Sophie",
      "startTime": 21.14,
      "finishTime": 23.92,
      "dialogue": {
        "text": "That sounds straightforward. Anything else I should keep in mind?",
        "align": "left"
      }
    },
    {
      "character": "Brian",
      "startTime": 24.32,
      "finishTime": 27.12,
      "dialogue": {
        "text": "You should also reference issues in your commit message",
        "align": "right"
      }
    },
    {
      "character": "Brian",
      "startTime": 27.12,
      "finishTime": 29.44,
      "dialogue": {
        "text": "if you're working on a task related to an issue.",
        "align": "right"
      }
    },
    {
      "character": "Brian",
      "startTime": 29.88,
      "finishTime": 33.67,
      "dialogue": {
        "text": "It helps in tracking progress and understanding the context of changes.",
        "align": "right"
      }
    },
    {
      "character": "Sophie",
      "startTime": 34.28,
      "finishTime": 37.1,
      "dialogue": {
        "text": "Thanks for the clarification. I'll make sure to follow these steps.",
        "align": "left"
      }
    },
    {
      "character": "Brian",
      "position": { "x": 125, "y": 0, "z": 1 },
      "startTime": 37.6
    },
    {
      "character": "Sophie",
      "position": { "x": -25, "y": 0, "z": 1 },
      "startTime": 38.1
    }
  ]
}