Github page is the most important place as a developer and here is why it is so important

  • Are the projects well organized…by looking at the directory structure naming, can I get a sense of the architecture/design — it is easy to figure out where to go in the project to locate the various functional areas and layers.
  • Do projects have clear README and contribution guidelines written out clearly? Do you have good communication and documentation skills?
  • Does the first thing I see (the README) clearly describe the project e.g. what it does, how to run and build it etc?
  • Is the code clean, easy to read, and commented appropriately?
  • Is there an organized branching/tag process being followed, e.g. gitflow
  • Is there some sense that the person understands basic design patterns?
  • Does the project leverage existing open source libraries and frameworks (good) or does the code re-solve common problems/routines (bad)
  • Forks of other repos on which you have made pull requests (don’t worry about whether they’ve been accepted or not).
  • Do I see replicated code i.e. do I see obvious ‘cut and paste’ and ‘repeating myself’ code (bad)
  • ARE THERE TESTS!!!! There should be a test harness and if I run it (because the README told me how to run them), the tests should pass. This is a big one for me. If I don’t see tests, the very first question I will ask will be ‘how do/did you test this code’ and your answer will be ‘manually’ which of course means you don’t test!! IMO, professional quality code includes some level of unit/integration testing delivered along with it.
  • I am less concerned with what the project does, more concerned that it was developed professionally. I look for commercial quality code… will others be able to take the project and easily enhance/maintain it.

To make it more human:

### Hi there 👋
* 👂 My name is ...
* 👩 Pronouns: ...
* 🔭 I’m currently working on ...
* 🌱 I’m currently learning ...
* 🤝 I’m looking to collaborate on ...
* 🤔 I’m looking for help with ...
* 💬 Ask me about ...
* 📫 How to reach me: ...
* ❤️ I love ...
* ⚡ Fun fact: ...

Make it collapsible

<summary><b>✨About Me</b></summary><br/>
Laboris id veniam velit sint exercitation ut amet aliquip sit.
Enim eu velit aliquip enim ex dolore culpa eu ut esse veniam
aliquip pariatur sint.

Add badges to make it more colorful using

Embed Github Stats

<img src="" />

Most Used Languages

<img src=""/>

Get Inspiration



Get the Medium app

A button that says 'Download on the App Store', and if clicked it will lead you to the iOS App store
A button that says 'Get it on, Google Play', and if clicked it will lead you to the Google Play store