Download as pdf or txt
Download as pdf or txt
You are on page 1of 2

CrushingDigital

GitHub Checklist

Bio
Be specific. ‘Software Developer’, ‘Front End Developer’ or ‘JavaScript Developer’
usually won’t cut it. List the tech! Preferably mirror your LinkedIn profile headline.

Profile Image
Sharp image (good quality)
Can clearly see your face
No sunglasses, fully clothed (yes, really!)
Professional (Be smart, but not overly so. A suit can scare some employers)
Ensure it matches your other profile images (e.g LinkedIn)

Pinned Repositories
Pin 2-3 of the best examples of your work
Ensure pinned repos are in the tech you want to be known for
Ensure each repo has a good description (see here)
Ensure repo title is descriptive and of good quality (e.g. NOT create-react-app)

Contributions
Contributions are nice to have, not a requirement!
Ensure recent contributions are in the relevant technology

Repository List
It’s in chronological order so ensure the relevant tech appears recently
Beware of presenting that you are tutorial hell (i.e. one bigger project is usually
preferred)
Beware tech red flags: If you are applying for React roles and your website is in Vue,
be prepared to explain that.

© Copyright Crushing Digital Ltd. 2023


CrushingDigital
Repositories

Figure 1

About:Description See Figure 1


Describe the tech used (e.g. The language on the repo might say JavaScript, ensure
that recruiters know it is React being used)
Describe purpose of the repo (keep it brief)

About:Topics See Figure 1


Confirm ALL the technologies used by the project

Note: Here you are working on the elements that make for an interesting repository snippet that would
be seen in your repository list (as per Figure 2) and in your pinned repository section

Figure 2

ReadMe
Ensure the tech used is listed
Show how to view a live link to the project (if applicable)
The above is in addition to the usual rules for repositories such as helping
users to use the repo

Contact Information
Include an email address
Link a website. Consider your LinkedIn profile?

© Copyright Crushing Digital Ltd. 2023

You might also like