Skip to content

project-instructions.md

Latest commit

 

History

History
61 lines (43 loc) · 2.09 KB

project-instructions.md

File metadata and controls

61 lines (43 loc) · 2.09 KB
Raw

Project Instructions

We follow a common workflow. The first few times, it feels like a lot, but it gets better.

WEDNESDAY: Complete Workflow Phases 1-3

Follow ⭐ 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

Continue with the same guide to complete:

  1. Phase 4. Make a Technical Modification - make one small, observable, explainable change and keep the project running.
  2. Phase 5. Apply the Skills to a New Problem - implement a custom project based on the example; see your-files.md for naming.

Professional Communication

Code & Data Files (As Used in This Project)

  • src/ - modules named with your alias
  • notebooks/ - notebooks named with your alias
  • data/raw/ - source inputs
  • data/processed/ - processed exports, if any
  • artifacts/ - database files, logs, reports, or other outputs

README.md

Update the project landing page to describe your work: badges, tagline, project description, run commands, links to key artifacts, any visuals.

docs/index.md

Your analytics write-up - the introduction, data description, objective & process, results & insights, future work, and the techniques you applied (be explicit while in school; later your skills become more implicit).

GitHub About

Set the About section with a link to your GitHub Pages site. Check the box. The workflow includes how to set the repo Pages to GitHub Actions. Pushing to GitHub automagically triggers an action to deploy the docs.

Portfolio Checklist

  • Working project
  • Meaningful insights with logged results
  • Understanding of your chosen domain
  • Accessible narrative
  • Images, tables, logs, or output conveying your work
  • GitHub About section linking to your GitHub Pages site