PROJECT 5
TO DO LIST

Introduction

For Project 5, we'll be creating a To Do List program in Python.
You'll continue to learn more concepts in Python as well as reinforce the software development we have been using for each project.

What You Will Learn

By the end of this project, you will have gained valuable experience and foundational skills that will be useful for future projects:

• Master the basics of creating and using lists in Python.

• Learn how to add to and remove items from lists.

• Learn how to search and sort lists.

• Learn how to identify and fix common types of errors.

These skills are essential for anyone starting in programming and will help you tackle more complex projects in the future.

1. Requirements / Specifications

For this task we will look at combining the "Requirements Definition" and "Determining Specifications" steps. Remember the former is "what" and the latter is "how", so we will create a table that represents this. 

Listen to Leah below, she has a program he wants you to build. If you're still not sure afterwards, you can chat with her using the chatbot below.
📖  Afterwards, write down at least five requirements into your workbook, in plain-English, that you think Leah wants you to include in the program. These should be ordered from highest priority (essential features) to lowest priority (nice to haves).
In the second column (specifications), write down how you think you will implement those requirements. The labs will help with this, so add more detail later if necessary. Also, an example from the guessing game project is provided to help you understand what to do.

2. Design:

Design is your game plan. Before you start coding, you sketch out what steps your program needs to take and how it should flow.

Storyboards

Storyboarding is a valuable technique in software development as it facilitates visualizing the user's journey through the application, rather than focusing on isolated screens. This approach helps in creating a cohesive user experience, as developers and designers can understand how users will interact with the software in a sequence of steps. Storyboarding surpasses a single screen design by providing a broader perspective of the application's flow, interactions, and transitions.

📖 In your workbook, complete the storyboard activity.

3. Development:

Now comes the fun part: actually making your program. This is where you write the code. Open the GitHub Classroom assignment.
There are four labs to complete in order to learn the concepts necessary to complete this project. Complete these first.

5. Testing and Debugging:

What Makes Readable Code?

Readable code is not just about writing code that works; it's about writing code that other people (and your future self) can understand easily. Here are some key aspects:

1. Clear Naming Conventions: Use meaningful names for variables, functions, and classes.
   For example, total_price is more understandable than just tp.

2. Consistent Indentation and Spacing: Consistency in spacing and indentation makes your code more organised and easier to follow.

3. Logical Structure: Organise your code in a logical manner. Related functions and variables should be grouped together.

4. Minimal Complexity: Avoid overly complex solutions. Simpler code is usually better.
   Break down complex problems into smaller, manageable functions.
   
   

What Are Quality Comments?

Comments in your code are not for the computer; they are for humans. Quality comments help explain the purpose and logic of your code.
Here's what they should do:

1. Explain Why, Not What: Good comments explain why a certain piece of code is there or why it’s written in a particular way.
   Avoid stating the obvious.

2. Provide Context: Sometimes, the context in which something is done is not immediately obvious.
   Good comments can provide that missing context.

3. Document Non-Obvious Choices: If you chose a specific approach that might not seem straightforward, explain your reasoning.
   
   

Why This Matters for Software Engineers

As a software engineer, you often work in teams. Writing readable code with quality comments makes it easier for your teammates to understand, maintain, and build upon your work. It's not just about the code functioning correctly; it's about making the code sustainable and accessible for future development.

📖 Complete the peer code review activity in your workbook.

Hand-In + Quiz