🔵 Make a Modification¶

Start by Copying the Example Files¶

Keep the working examples. Copy each provided file so you have something to experiment with.

For more information, see your project repo docs/your-files.md.

It takes a few words but basically, copy each file in these folders:

• data/
• src/
• notebook/

And change:

_case to _yourname.

Professional Modifications¶

A technical modification is a deliberate change that affects what the project does or produces.

Start with a small change and observe the result. Small, incremental changes make cause and effect easier to understand.

Requirements¶

Your modification must:

• be your own work
• be described in your documentation or notes
• run successfully after the change

Examples of Technical Modifications¶

A. Change an Input or Setting¶

• use a different input file or dataset
• change a parameter, threshold, or configuration value
• adjust a filter, selection, or query

B. Change the Logic¶

• add, remove, or adjust a transformation step
• add a new feature, metric, or derived value
• modify how results are computed or summarized

C. Change the Output¶

• add a new result table, report, or summary
• add a new visualization (or adjust an existing one)
• change how results are saved (format, naming, location)

D. Improve Observability¶

• add or refine logging statements
• add basic validation checks (for example: missing values, ranges, schema)
• improve error messages or warnings

Record Your Modification¶

Document what you did:

• Required: describe the change in README.md
• Required: describe the change in your Git commit message
• Optional: add additional notes in the docs/ folder

Record:

• what you changed
• why you made the change
• what you observed after running the project