curriculum/challenges/english/blocks/learn-how-to-document-code-for-a-project/65e9991e59d4b959920e8c7d.md
Listen to the audio and answer the question.
When should Sophie reference issues in her commit messages, and why?
When working on any task, to make the messages longer
The focus isn't on making messages longer but on providing specific information for tasks related to an issue.
When working on tasks related to an issue, to help track progress and understand changes
Always, in every task she works
Brian specifically mentions referencing issues when the task is related to one, not always.
When she completes a task, to show she has finished it
Referencing issues is meant for context and tracking progress, not just to indicate task completion.
2
{
"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": 23.32,
"finishTimestamp": 32.7
}
},
"commands": [
{
"character": "Brian",
"opacity": 1,
"startTime": 0
},
{
"character": "Brian",
"startTime": 1,
"finishTime": 3.8,
"dialogue": {
"text": "You should also reference issues in your commit message",
"align": "center"
}
},
{
"character": "Brian",
"startTime": 3.8,
"finishTime": 6.12,
"dialogue": {
"text": "if you're working on a task related to an issue.",
"align": "center"
}
},
{
"character": "Brian",
"startTime": 6.56,
"finishTime": 10.38,
"dialogue": {
"text": "It helps in tracking progress and understanding the context of changes.",
"align": "center"
}
},
{
"character": "Brian",
"opacity": 0,
"startTime": 10.88
}
]
}