Repository Refactor

Setting the Scene

You are a hiring manager, and you have a few candidates to choose between to bring in for an interview. You can only select one, so it needs to be the best candidate.

Your company, like many tech companies, makes decisions to interview after reviewing project READMEs. Note: this actually happens!

Who do you bring in for the interview? How do you decide?

Who do You Interview?

Break up into small groups, and get a piece of chart paper with a marker.

The Candidates

Here is a set of repositories, each representing a candidate:

You have 20 minutes to go through these repositories and determine who you want to bring in for the interview - READMEs only.

On your chart paper, you should write about what you looked for in the READMEs.

  • What should every README have?
  • What stood out about good READMEs?
  • Anything you should avoid in a README?

At the end of the 20 minutes, One person from each group will share out their findings and reasoning for choosing who they would hire.

The Decision

Bring your chart papers to the front of the class, and let’s talk about commonalities we find between them.

Who do you bring in for the interview? Why?

Self Assessment and Planning

Take 5-10 minutes to look through your GitHub profile, identify repositories you want to showcase, and look at your own READMEs.

Where do you need to improve? What things about successful READMEs that we identified have you already implemented?

Work Time

  1. Decide the top repos that you want to showcase (6 as a maximum)
  2. Pin them to your GitHub profile
  3. Identify what you need to add or change about each repository README

Share Out

What other things about repositories should be taken into consideration beside the README?

Lesson Search Results

Showing top 10 results