Skip to content

Commit 666d731

Browse files
committed
differences for PR #502
1 parent d38ee4c commit 666d731

4 files changed

Lines changed: 22 additions & 19 deletions

File tree

50-section5-intro.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,10 @@ how the outside world interacts with and makes use of our software,
3030
how others can interact with ourselves to report issues,
3131
and the ways we can successfully manage software improvement in response to feedback.
3232

33-
![](fig/section5-overview.svg){alt='Managing software' .image-with-shadow width="1000px" }
33+
![Managing software](fig/section5-overview.svg){
34+
alt='Flow chart showing five stages in software management lifecycle: 1. Setting up software environment; 2. Verifying software correctness; 3. Software development as a process; 4. Collaborative development for reuse; 5. Managing software over its lifetime - issue reporting & prioritisation, Agile development in sprints, software project management.'
35+
.image-with-shadow width="1000px"
36+
}
3437

3538
<!--
3639
Source of the above image can be rendered in the Mermaid live editor:

51-managing-software.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -68,12 +68,12 @@ currently there should be none.
6868
If you do not see the `Issues` tab, you must first enable it in the settings of your repository:
6969
go to the `Settings` tab, scroll down to the `Features` section and activate the checkmark on `Issues`.
7070

71-
![](fig/github-issue-list.png){alt='List of project issues in GitHub' .image-with-shadow width="1000px"}
71+
![](fig/github-issue-list.png){alt='Screenshot showing issue list tab in GitHub web interface for a repository named python-intermediate-inflammation. There are currently no issues listed and the new issue button in interface is highlighted.' .image-with-shadow width="1000px"}
7272

7373
Let us go through the process of creating a new issue.
7474
Start by clicking the `New issue` button.
7575

76-
![](fig/github-new-issue.png){alt='Creating a new issue in GitHub' .image-with-shadow width="1000px"}
76+
![](fig/github-new-issue.png){alt='Screenshot showing new issue form in GitHub web interface. The form currently has no details entered in title or comment fields with cursor currently in title field.' .image-with-shadow width="1000px"}
7777

7878
When you create an issue, you can add a range of details to them.
7979
They can be *assigned to a specific developer* for example -
@@ -266,7 +266,7 @@ you can reference a commit by pasting its long, unique identifier
266266
and GitHub will render it nicely using the identifier's short form
267267
and link to the commit in question.
268268

269-
![](fig/github-reference-comments-commits.png){alt='Referencing comments and commits in GitHub' .image-with-shadow width="700px"}
269+
![](fig/github-reference-comments-commits.png){alt='Screenshot of comment thread in a GitHub issue showing dropdown menu expanded for a particular comment to allow copying link to comment to reference elsewhere. Also shown and highlighted is a autolink to a particular commit hash.' .image-with-shadow width="700px"}
270270

271271
::::::::::::::::::::::::::::::::::::::: challenge
272272

@@ -368,7 +368,7 @@ this course but it is good to be aware of how to make use of them when suitable.
368368
1. From your GitHub account's home page (not your repository's home page!),
369369
select the "Projects" tab, then click the `New project` button on the right.
370370

371-
![](fig/github-new-project.png){alt='Adding a new project board in GitHub' .image-with-shadow width="800px"}
371+
![](fig/github-new-project.png){alt='Screenshot of projects tab for a GitHub user profile with new project button highlighted.' .image-with-shadow width="800px"}
372372

373373
2. In the "Create project" pop-up window, you can either start from one of the featured existing
374374
project templates or create your project from scratch using one of the three standard project
@@ -378,7 +378,7 @@ this course but it is good to be aware of how to make use of them when suitable.
378378
- Board - a "cards on a board" view of the project, with issues and pull requests being
379379
spread across customizable columns as cards on kanban board
380380
- Roadmap - suitable for a high-level visualisation of your project over time.
381-
![](fig/github-project-template.png){alt='Selecting a project board template in GitHub' .image-with-shadow width="800px"}
381+
![](fig/github-project-template.png){alt='Screenshot of create project pop-up window showing a grid with four featured project templates - Team planning (caption "Manage your team's work items, plan upcoming cycles, and understand team capacity"), Future release (caption "Manage your team's prioritized work items when planning for a feature release"), Kanban (caption "Visualize the status of your project") and Bug tracker ("Track and triage your bugs"). In the the sidebar additional options are available to start a project from scratch using a table, board or roadmap format.' .image-with-shadow width="800px"}
382382
Regardless of which project type/view you select, you can easily switch to a different
383383
project layout later on.
384384

@@ -387,8 +387,8 @@ this course but it is good to be aware of how to make use of them when suitable.
387387

388388
4. After it is created, you should also populate the description of the project from the project's Settings,
389389
which can be found by clicking the `...` button in the top right corner of the project.
390-
![](fig/github-project-settings.png){alt='Project board setting in GitHub' .image-with-shadow width="800px"}
391-
![](fig/github-project-description.png){alt='Adding project description and metadata in GitHub' .image-with-shadow width="800px"}
390+
![](fig/github-project-settings.png){alt='Screenshot showing how to access project board settings in GitHub. A dropdown menu has been expanded from the "Show Options" button with Settings option within this menu highlighted.' .image-with-shadow width="800px"}
391+
![](fig/github-project-description.png){alt='Screenshot showing project settings page in GitHub. Short description field on page has had text "Tasks for the v0.1 release of the inflammation project" entered.' .image-with-shadow width="800px"}
392392
After adding a description, select `Save`.
393393

394394
5. GitHub's default card board template contains
@@ -398,7 +398,7 @@ this course but it is good to be aware of how to make use of them when suitable.
398398
- `In Progress`
399399
- `Done`
400400

401-
![](fig/github-project-view-add-remove-items.png){alt='Default card board in GitHub' .image-with-shadow width="800px"}
401+
![](fig/github-project-view-add-remove-items.png){alt='Screenshot showing default card board in GitHub. Three columns are shown headed Todo, In Progress and Done. A button to add a new task to a column is highlighted at bottom of Todo column. On the right of interface a ... button which expands a menu from which a column can be removed and a + button which can be used to add a new column are highlighted.' .image-with-shadow width="800px"}
402402

403403
You can add or remove columns from your project board to suit your use case.
404404
One commonly seen extra column is `On hold` or `Waiting` -
@@ -424,7 +424,7 @@ this course but it is good to be aware of how to make use of them when suitable.
424424
and selecting the repository
425425
and an issue or pull request from that repository that you want to add.
426426

427-
![](fig/github-project-new-items.png){alt='Adding issues and notes to a project board in GitHub' .image-with-shadow width="800px"}
427+
![](fig/github-project-new-items.png){alt='Screenshot showing adding issues and notes to a project board in GitHub. The board shows three columns Todo, In Progress and Done, with three draft tasks entered into the Todo column: Finish off documenting the software; Select licence; Prepare the release notes.' .image-with-shadow width="800px"}
428428

429429
Notes contain task descriptions and can have detailed content like checklists.
430430
In some cases, e.g. if a note becomes too complex,
@@ -433,7 +433,7 @@ this course but it is good to be aware of how to make use of them when suitable.
433433
or write more detailed comments
434434
(for that, use the `Convert to issue` option from the `...` menu on the card itself).
435435

436-
![](fig/github-convert-task-to-issue.png){alt='Converting a task to issue' .image-with-shadow width="800px"}
436+
![](fig/github-convert-task-to-issue.png){alt='Screenshot showing converting a task to issue in GitHub project interface. A draft task "Finish off documenting the software" is selected and a context menu shown with multiple options, with the first "Convert to issue" highlighted.' .image-with-shadow width="800px"}
437437

438438
7. In addition to creating new tasks as notes and converting them to issues -
439439
you can add an existing issue or pull request (from any repository visible to you)
@@ -449,7 +449,7 @@ this course but it is good to be aware of how to make use of them when suitable.
449449
9. Finally, you can change the way you view your project by adding another view.
450450
For example, we can add a Table view to our Board view by clicking the `New button`
451451
and selecting it from the drop down menu.
452-
![](fig/github-project-add-view.png){alt='Add another project view' .image-with-shadow width="800px"}
452+
![](fig/github-project-add-view.png){alt='Screenshot showing how to add another project view in GitHub Project interface. A second table view of the project is shown, with two view tabs, View 1 and View 2 now present and View 2 active. The "New view" button to right of view tabs is highlighted.' .image-with-shadow width="800px"}
453453

454454
::::::::::::::::::::::::::::::::::::::: challenge
455455

53-improvement-through-feedback.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -202,20 +202,20 @@ We can create a new one by selecting `Issues` on our repository,
202202
then `Milestones` to display any existing milestones,
203203
then clicking the "New milestone" button to the right.
204204

205-
![](fig/github-milestones.png){alt='Milestones in GitHub' .image-with-shadow width="1000px"}
205+
![](fig/github-milestones.png){alt='Screenshot showing how to access Milestones interface in GitHub. The Issues tab for a repository is shown with Milestones button to left of New Issue button highlighted.' .image-with-shadow width="1000px"}
206206

207-
![](fig/github-create-milestone.png){alt='Create a milestone in GitHub' .image-with-shadow width="1000px"}
207+
![](fig/github-create-milestone.png){alt='Screenshot showing how to create a milestone in GitHub. The Milestones view within Issues tab is shown with a message indicating no milestones have been created so far. Two buttons for creating a new milestone are highlighted.' .image-with-shadow width="1000px"}
208208

209209
We add in a title,
210210
a completion date (i.e. the end of this timebox),
211211
and any description for the milestone.
212212

213-
![](fig/github-new-milestone-description.png){alt='Create a milestone in GitHub' .image-with-shadow width="800px"}
213+
![](fig/github-new-milestone-description.png){alt='Screenshot showing how to create a milestone in GitHub. A new milestone form is shown with three entry fields, a short text field for entering title, a date picker field for selecting due date (optional) and a long text field for entering description.' .image-with-shadow width="800px"}
214214

215215
Once created, we can view our issues
216216
and assign them to our milestone from the `Issues` page or from an individual issue page.
217217

218-
![](fig/github-assign-milestone.png){alt='Milestones in GitHub' .image-with-shadow width="1000px"}
218+
![](fig/github-assign-milestone.png){alt='Screenshot showing how to assign an issue to a milestone. The issue list tab of a repository is shown with a single issue "Add README" selected and the Milestone dropdown on issue filter controls expanded with a list of available milestones that can be assigned to the issue shown, currently showing one milestone "Tidy up documentation".' .image-with-shadow width="1000px"}
219219

220220
Let us now use Milestones to plan and prioritise our team's next sprint.
221221

md5sum.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,10 @@
3232
"episodes/41-code-review.md" "e86600e42548b6d652fb9b43450222fc" "site/built/41-code-review.md" "2025-06-19"
3333
"episodes/42-software-reuse.md" "d97b8a23401a52bfb6dc5e564981fcf2" "site/built/42-software-reuse.md" "2024-12-06"
3434
"episodes/43-software-release.md" "6c708ecebb218556a6fb632f37c47d1e" "site/built/43-software-release.md" "2026-01-27"
35-
"episodes/50-section5-intro.md" "85de74adcd13ba9e8a6df600a17b9ddc" "site/built/50-section5-intro.md" "2024-12-06"
36-
"episodes/51-managing-software.md" "666be3cf81dab6bb120f649c65bd64c1" "site/built/51-managing-software.md" "2025-02-25"
35+
"episodes/50-section5-intro.md" "c7ca49dbfa97442f4d1040c542fbf173" "site/built/50-section5-intro.md" "2026-02-19"
36+
"episodes/51-managing-software.md" "08252c6b4732cf2d9e084b0da7f340fb" "site/built/51-managing-software.md" "2026-02-19"
3737
"episodes/52-assessing-software-suitability-improvement.md" "f13f4136753468a43d3c2364fa6aabd4" "site/built/52-assessing-software-suitability-improvement.md" "2025-07-30"
38-
"episodes/53-improvement-through-feedback.md" "b46cb516f900e5001609c4d4165254ae" "site/built/53-improvement-through-feedback.md" "2024-12-06"
38+
"episodes/53-improvement-through-feedback.md" "4f1b3bee47fa2ec10d145fc298e5952b" "site/built/53-improvement-through-feedback.md" "2026-02-19"
3939
"episodes/60-wrap-up.md" "8063854ac1eeeea9c176700fe6990045" "site/built/60-wrap-up.md" "2024-12-06"
4040
"instructors/instructor-notes.md" "7d8b58203bcdda8c2aff87ea697a61fd" "site/built/instructor-notes.md" "2025-07-30"
4141
"learners/quiz.md" "bd60170ec9f07bc2d510f55353179217" "site/built/quiz.md" "2024-12-06"

0 commit comments

Comments
 (0)