Skip to content

Project Instructions

WEDNESDAY: Complete Workflow Phases 1-3

Follow the instructions in ⭐ Workflow: Apply Example to complete:

  1. Phase 1. Start & Run - copy the project and confirm it runs
  2. Phase 2. Change Authorship - update the project to your name and GitHub account
  3. Phase 3. Read & Understand - review the project structure and code

FRIDAY/SUNDAY: Complete Workflow Phases 4-5

Again, follow the instructions above to complete:

  1. Phase 4. Make a Technical Modification - make a change and verify it still runs
  2. Phase 5. Apply the Skills to a New Problem

More About Phase 4

Follow the instructions in ⭐ Workflow: Apply Example to complete Phase 4 and make a small change without breaking anything.

Your technical modification should be small, observable, and easy to explain.

More About Phase 5

Follow the instructions linked above to complete Phase 5 and apply the techniques to solve a novel problem.

Implement a custom project based on the example.

Keep the working example and your custom code in the repository together until your work has been assessed.

After your work has been assessed, you may remove the working example and tailor your custom project as you like.

Professional Communication

Make sure the title and narrative reflect your work.

Update key documentation files:

  • Update README.md - to include your commands, process, results
  • Update docs/index.md - describe your Phase 4 and Phase 5 customizations, skills, and insights.

Update and verify your code files, either (or rarely, both):

  • src/ - your modules, named with your alias, as appropriate
  • notebooks/ - your notebooks, named with your alias, as appropriate

Update and present your data files, as appropriate to the project:

  • data/raw/ - source inputs
  • data/processed/ - processed data exports, if the project creates any
  • artifacts/ - generated database files, logs, reports, or other outputs

Portfolio Presentation

Ensure your project clearly demonstrates:

  • a working project
  • meaningful insights with logged results
  • understanding of your chosen domain
  • accessible narrative
  • appropriate images, tables, logs, or output conveying your work
  • a GitHub repo About section with a link to your GitHub Pages site