Today we're going to talk about how to create a resume on GitHub. When looking for a job (especially your first job), all methods are good and it's clearly not the best idea to simply dismiss any of them. What's more, a GitHub resume is an excellent way to polish your GitHub account, which serves as your software development portfolio and contains essential information about your work. In short, this is a useful step in developing your tech brand. You can think of this post as a continuation of the article on working with GitHub, improving your profile, learning GitHub features (I wrote about this previously). Overall, I find this approach (a resume on GitHub) quite interesting and fresh. Just for you, I've collected here all the coolest solutions that I've encountered.
from Deadpool (2016). 20th Century Fox Film Corporation
Who can write a resumeAs they say, Rome was not built in a day. Following this proverb, you should start writing your resume as early as possible. Yes, you won't be able to list many years of professional work experience at first. But there is always something you can say about yourself. And your resume is just the right place to talk about it. Even if you start with this: I'm Joe Schmoe, a beginner Java developer. I know Java SE. You can contact me at... And then, as you are learning and gaining some experience, you add new details to your resume. Did you complete the Java Project From A To Z? Write about that. Mention the technologies that you used there. An experienced developer will always have something to say about himself or herself.
Getting started creating your resumeThe first thing to do is create a new repository with the same name as your username on GitHub. I will show all this with myself as an example: As you can see from the message in the light green block, we are on the right track. All of the information in the resume will be in this project's README.md file. We create a repository and return to the profile page, where we will see the project's README at the top: We only have Hi there so far, but we have a start. Now comes the moment for us to fill out this file. If you start editing the README, you'll notice it has commented out text that suggests a certain structure: ### Hi there 👋 <!-- **romankh3/romankh3** is a ✨ _special_ ✨ repository because its `README.md` (this file) appears on your GitHub profile. Here are some ideas to get you started: - 🔭 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: ... - 😄 Pronouns: ... - ⚡ Fun fact: ... --> In general, my understanding is that a GitHub resume should not repeat all the information that we've already indicated on LinkedIn. What does that mean? It means that on LinkedIn we usually give a detailed account of our work experience, projects, technologies, educational background (possibly more than one), relevant courses, volunteering experience, and much more really important stuff. That's why GitHub should have the most selective information with links to social networks, where people can find out more about you.
Adding links to social media profilesNow it's time to add links to social media profiles that will provide all the necessary additional information about us. To do this, we will use the shields.io service, which lets us add icons for our links. You can add a YouTube channel and Twitter and more. Also full GitHub statistics. If this is important to you, you should really add it. I want to add my email address and links to my LinkedIn profile and Telegram channel. I haven't found anything like this here, so I will use another GitHub repo — alexandresanlim/Badges4-README.md-Profile. It has everything I need and more. Using this as a template, I added three links at the very beginning: LinkedIn, Telegram and Gmail. These are actually enough for me:
- LinkedIn is for people interested in professional collaboration. All my professional experience is described there;
- Telegram is my channel, which I am currently building and try to post wherever possible;
- Gmail is the email address I want people to use to contact me. I don't especially try to push my personal Telegram account in order to keep it for personal communication. But an email address is understandable and suitable for communication with everyone.
I had to hardcode the height of the images to get them on the same line. I set height = 150. One cool thing is the profile view counter. Not very informative, but cool. At least have some statistic on the number of profile views. Yes, I know that it is not as informative as I would like, but it is what it is. So let's add a counter like this at the end:
<p align='center'> <a href="https://github-readme-stats.vercel.app/api?username=romankh3&show_icons=true&count_private=true"> <img height=150 src="https://github-readme-stats.vercel.app/api?username=romankh3&show_icons=true&count_private=true"/></a> <a href="https://github.com/romankh3/github-readme-stats"> <img height=150 src="https://github-readme-stats.vercel.app/api/top-langs/?username=romankh3&layout=compact"/></a> </p>
The next iteration came out like this: That's better, right? :) Next, let's add logos for the technologies we want to show off. Again, displaying everything all at once will take a lot of time, so you can do it step by step. I will skip this stage simply because the time for this article has already passed :) That means we get the following resume code:
<div align="center" style="margin: 40px 0"> <a href="https://github.com/romankh3/github-profile-views-counter"> <img width="175px" src="https://komarev.com/ghpvc/?username=romankh3&color=DE002D"> </a> </div>
To use static data, just replace my username with the desired one. What does this look like in action? You can see it here on my account page. Subscribe. Let's reach a THOUSAND subscribers together :)
# Hi, I'm Roman 👋 A senior software engineer with more than 5 years of professional experience. I have excellent knowledge of backend Java development. In general, I've worked with monolithic, microservice and serverless architectures. A lot of my activity is open-source. <p align='center'> <a href="https://github-readme-stats.vercel.app/api?username=romankh3&show_icons=true&count_private=true"><img height=150 src="https://github-readme-stats.vercel.app/api?username=romankh3&show_icons=true&count_private=true"/></a> <a href="https://github.com/romankh3/github-readme-stats"><img height=150 src="https://github-readme-stats.vercel.app/api/top-langs/?username=romankh3&layout=compact"/></a> </p> <p align='center'> <a href="https://www.linkedin.com/in/romankh3/"> <img src="https://img.shields.io/badge/linkedin-%230077B5.svg?&style=for-the-badge&logo=linkedin&logoColor=white"/> </a>> <a href="https://t.me/joinchat/SpqRPBFo_sM6qm05"> <img src="https://img.shields.io/badge/Telegram-2CA5E0?style=for-the-badge&logo=telegram&logoColor=white"/> </a> <p align='center'> 📫 How to reach me: <a href='mailto:firstname.lastname@example.org'>email@example.com</a> </p> ### Key points * Creator of [Javarush Community](https://github.com/javarushcommunity) and [Template Repository](https://github.com/template-repository) organizations. * Creator and author of [romankh3](https://t.me/romankh3) Telegram channel. Subscribe to receive messages about my open-source activities. * I write posts about software development. * Currently working in [Epam Systems](https://www.linkedin.com/company/epam-systems/) ## 🛠 Technology Stack * Java/Kotlin/Groovy/COBOL languages * MySQL, PostgreSQL, MongoDB, Aurora, DynamoDB, Flyway, Liquibase * Spring Framework, Spring Boot, Spring Test, Spring Data JPA, Spring JDBC template, Spring Cloud Contract and so on... * Camunda, Camunda Cockpit, Camunda Modeler * GitHub/GitLab/Gerrit/Bitbucket ### My opensource projects * [image-comparison](https://github.com/romankh3/image-comparison) - Published on Maven Central Java Library; it compares 2 images of the same size and shows the differences visually by drawing rectangles. Some parts of the image can be excluded from the comparison. * [JavaRush TelegramBot](https://github.com/javarushcommunity/javarush-telegrambot) - JavaRush Telegram bot from the community to the community * [Skyscanner Flight API client](https://github.com/romankh3/skyscanner-flight-api-client) - Published on Maven Central Java Client for a Skyscanner Flight Search API hosted in Rapid API * [Flights-monitoring](https://github.com/romankh3/flights-monitoring) - Application for monitoring flight cost based on Skyscanner API <div align="center" style="margin: 40px 0"> <a href="https://github.com/romankh3/github-profile-views-counter"> <img width="175px" src="https://komarev.com/ghpvc/?username=romankh3&color=DE002D"> </a> </div>