github-tips

Ver versión en Español

How to create an effective GitHub profile:

Recruiters or technical interviewers usually review the CV + the GitHub profile, so having a good profile can give you many advantages when it comes to being considered for a job.

💡 Tips that can help you:

Fill out the basic data

• Professional and contact information
• Photo

Create profile repository

• Steps: Add repo with name <username> and check off the option to add README.md 👉 see documentation
• Add to the README.md links to the most important projects (and pin them)
• Give it personality (the README.md description doesn’t have to be like a formal resume)
• Examples:
  • https://github.com/ymulenll
  • https://github.com/thmsgbrt
  • https://github.com/gautamkrishnar
  • https://github.com/anmol098
  • https://github.com/Prince-Shivaram
• You can start your README.md using this webpage
• Learn the language used to write and modify .md files 👉 see documentation
• Important for SEO (it is what appears as a description in search engines)

Upload all your projects:

• Shows the way you organize projects (file structure) and your coding style
• Clean code tips:
  • Readlable variable names
  • Small functions focused on one thing
  • Files with few lines of code and focused on few things (Avoid generic files where you add anything)
  • Avoid redundant comments (if you make clean code with small functions, you usually don’t need many comments)

Add metadata in projects:

• Description, website, tags

Add README.md to all projects:

• It must include:
  • Purpose and use cases of your project
  • Installation instructions (if necessary)
  • Demo: screenshots, gifs and/or website (github pages, netlify)
• This shows:
  • The ability to communicate (super important)
  • Interest in working on a project for a long time (discipline, perseverance)

Frequent Commits

• Activity in commits, showing consistency is an indicator of your level of interest and discipline
• Good practices when doing commits:
  • The Commits should be small and focused on a specific change or task
  • Comments in imperative
• Activate private contributions

Star ⭐️ projects (add a star this repo if you wish 😁)

• This shows the technologies they are interested in
• Don’t fork projects you don’t work on

Create website and host it with GitHub pages

• Create main page
• Host any existing repository

Pro Tip: Automate with Actions

• 👉 see documentation
• example: Update README with the latest Youtube videos

Contribute to Open Source

• They can start with small things like correcting errors in the documentation

📫 My networks:

• LinkedIn: https://linkedin.com/in/yoelvismulen
• Twitter: https://twitter.com/ymulenll
• Youtube: https://www.youtube.com/yoelvism

---

May you have successes in your professional career 🎉!