Skip to content

Learning: Portfolio + Open Source

How to Use This Page

  • Build artifacts that prove outcomes, not just effort.
  • Keep demos reproducible for first-time reviewers.
  • Use open-source practices to show collaboration quality.

Lesson 1: Fundamentals

Learn how to present project value with clear technical artifacts.

What You Learn

  • How to write outcome-focused READMEs
  • Why architecture and run instructions must be unambiguous
  • How assumptions and limitations increase reviewer trust

Walkthrough

  1. Draft README sections: problem, approach, results.
  2. Add setup, run, and verification steps.
  3. Include known limits and next steps.

Try It Yourself

  • Rewrite one README section to focus on user impact.
  • Ask a peer to run your project using only README steps.
  • Capture issues they hit and improve clarity.

Lesson 2: Intermediate Patterns

Learn demo storytelling with evaluation and observability evidence.

What You Learn

  • How to present problem -> design -> result in short narrative form
  • Why metrics strengthen credibility in interviews
  • How reproducibility makes your claims verifiable

Walkthrough

  1. Build a 5-7 minute demo storyline.
  2. Add 2-3 key metrics with before/after context.
  3. Prepare a concise Q&A appendix for tradeoff questions.

Try It Yourself

  • Record a dry run and identify unclear sections.
  • Add one chart or table that strengthens your argument.
  • Tighten the demo to fit a strict time limit.

Lesson 3: Production Patterns

Learn open-source contribution workflows and long-term portfolio maintenance.

What You Learn

  • How ADR-style notes document important decisions
  • Why issue/PR hygiene signals professional maturity
  • How to track artifact impact over time

Walkthrough

  1. Document one design decision in ADR format.
  2. Create a contribution-ready issue and PR summary.
  3. Define simple portfolio health metrics to review monthly.

Try It Yourself

  • Submit one small OSS contribution with clear context and tests.
  • Add a changelog entry style for project evolution.
  • Define a 90-day portfolio improvement roadmap.

Code Examples

  • Starter script: docs/starter/stage12_portfolio_open_source.py
  • Stage architecture notes: docs/roadmap/stage-12-portfolio-case-study-and-oss/architecture.md