Skip to content

Commit

Permalink
Mainly review of episode on refactoring
Browse files Browse the repository at this point in the history
  • Loading branch information
anenadic committed Dec 14, 2023
1 parent b628416 commit e1f4e55
Show file tree
Hide file tree
Showing 7 changed files with 327 additions and 320 deletions.
2 changes: 1 addition & 1 deletion _episodes/30-section3-intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Section 3: Software Development as a Process"
colour: "#fafac8"
start: true
teaching: 5
teaching: 10
exercises: 0
questions:
- "How can we design and write 'good' software that meets its goals and requirements?"
Expand Down
4 changes: 2 additions & 2 deletions _episodes/31-software-requirements.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Software Requirements"
teaching: 15
exercises: 30
teaching: 25
exercises: 15
questions:
- "Where do we start when beginning a new software project?"
- "How can we capture and organise what is required for software to function as intended?"
Expand Down
5 changes: 2 additions & 3 deletions _episodes/32-software-design.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,8 +74,7 @@ goal of having *maintainable* code, which is:
* using meaningful and descriptive names for variables, functions, and classes
* documenting code to describe it does and how it may be used
* using simple control flow to make it easier to follow the code execution
* keeping functions and methods small and focused on a single task and avoiding large functions
that do a little bit of everything (also important for testing)
* keeping functions and methods small and focused on a single task (also important for testing)
* *testable* through a set of (preferably automated) tests, e.g. by:
* writing unit, functional, regression tests to verify the code produces
the expected outputs from controlled inputs and exhibits the expected behavior over time
Expand Down Expand Up @@ -125,7 +124,7 @@ software project and try to identify ways in which it can be improved.
> {: .solution}
{: .challenge}

## Technical Debt
## Poor Design Choices & Technical Debt

When faced with a problem that you need to solve by writing code - it may be tempted to
skip the design phase and dive straight into coding.
Expand Down
272 changes: 0 additions & 272 deletions _episodes/33-refactoring-functions.md

This file was deleted.

Loading

0 comments on commit e1f4e55

Please sign in to comment.