JavaRush /Java Blog /Random EN /We write a resume on GitHub. Brief guide

We write a resume on GitHub. Brief guide

Published in the Random EN group
Hi all. The series of articles on the Java project from A to Z has come to an end, which means that now you can write about all the other interesting topics. Today we'll talk about how to create a resume on GitHub. In the process of looking for a job (and especially your first job), all methods are good, and dismissing any of them is clearly not the best idea. Writing a resume on GitHub - 1In addition, this is an excellent continuation of the strategy for developing your GitHub account, which serves as the developer’s portfolio and contains the necessary information about him. In short, this is a useful step for developing your technical brand. This post can be considered a continuation of articles about experience working with GitHub, improving your profile, learning features (before that I wrote about Git and about setting up repositories on GitHub ). Overall, I find this approach (recap on GitHub) quite interesting and youthful. Especially for you, I have collected all the coolest solutions that I have come across.

Who can write a resume

As they say, Rome was not built in a day. Following this idea, you should start writing your resume as early as possible. Yes, at the beginning it will not be possible to indicate many years of commercial work experience. At the same time, there is always something to say about yourself. And a resume is exactly the place to talk about this. Even if it is written first: I am Vasya Pupkin, a beginner Java developer. I know Java SE. My contacts: ... ... And then, already in the process of studying, gaining some experience, you will add new details to your resume. Completed a Java project from A to Z? Write about it. Bring in the technologies that were used there. An experienced developer will always have something to say about himself.

Let's start creating a resume

The first thing to do is create a new repository with the same name as your username on GitHub. I will show all this with my own example: Writing a resume on GitHub - 2As can be seen from the message on the light green plate, we are on the right track. All information on the resume will be in the README.md file of this project. We create a repository and return to the profile page, there we will see at the top the README of this project: Writing a resume on GitHub - 3So far there is only Hi there , but a start has been made. Now comes the time to fill this file. If you start editing it, you'll notice some commented out text in the README 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, in my understanding, a resume on Github should not repeat all the information about ourselves that we indicate on LinkedIn. What does it mean? This means that on LinkedIn we usually describe in detail our work experience, what projects, what technologies, what education (there may be more than one), specialized courses, volunteer experience and much more that is really important to tell. Therefore, here, on Github, there should be the most consistent information with links to social networks where you can get more data.

Adding links to profiles on social networks

Now it's time to add links to social media profiles that would complement all the information about us. For this task, we will use the service shields.io , which has the ability to add icons for our links. There you can add a YouTube channel and Twitter and so on. Also full statistics on Github. To whom this is important, it's really worth adding. There is also the ability to add an icon for a BTC wallet. This can be used as a means for donations, because a normal sponsorship solution directly through GitHub was never brought to Ukraine, Russia, Belarus... Which, by the way, is a shame. I want to add my email, LinkedIn link and Telegram channel link. I didn’t find anything like this here, so I’ll use another turnip on Github - alexandresanlim/Badges4-README.md-Profile . It has everything I needed and more. Based on this, I added three links to myself at the very beginning: to LinkedIn, Telegram and Gmail. Basically this is enough for me:
  • LinkedIn is for those who are interested in commercial cooperation. All my commercial experience is described there;
  • Telegram is my channel, which I am currently developing and try to post it wherever possible (those who have been reading me for a long time, I think, have already noticed this :D);
  • Gmail is the email where you can contact me. I try to keep my personal telegram account low-key in order to keep it as a means of personal communication. And the mail is clear and suitable for communicating with everyone.
I would like to somehow highlight the Telegram channel, but have not yet figured out how to do it beautifully and appropriately. In the end it turned out like this: Writing a resume on GitHub - 4As I understand it, this description should be as compact and informative as possible. This is not the place where you need to describe in detail all your experiences and data about yourself. Therefore, we will try to do just that. During the first iteration of creation, my page didn’t look compact at all: Writing a resume on GitHub - 5So now I’ll try to make it even smaller... I’ll work on it some more. This, by the way, is a working approach when we gradually refine a solution. This is my first iteration and every time I come up with something better I will update. You may have noticed that in the General GitHub activity section I added statistics on the GitHub account, which I took from this turnip - anuraghazra / github-readme-stats . Yes, you can get general statistics on the stars of all repositories, the number of commits for the current year, the number of pull requests, and so on. And also - the variation in the use of programming languages. It is also useful to observe how the profile code base changes, especially if you start learning a new programming language. After several dances with HTML markup, I managed to set two statistics to the same width, line, and centered this thing, writing:
<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>
I had to hardcode the height of the tiles so that they were on the same line. I set height = 150. A cool thing is the counter for the number of profile views. Not particularly informative, but fun. Let there be at least some statistics 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. Therefore, at the end we will add this counter:
<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>
The next iteration turned out like this: Writing a resume on GitHub - 6That’s better, right?)) Next, we’ll add logos of the technologies that we’d like to show. Again, setting everything up 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 spent on the article has already expired) As a result, we get the following summary code:
# Hi, I'm Roman 👋
Senior Software Engineer with more than 5 years of commertial experience. I have excellent knowledge in backend development on Java.
In general worked with monolitic, microservice and serverless arthitectures. Big part of my acitities 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:roman.beskrovnyy@gmail.com'>roman.beskrovnyy@gmail.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 recieve messages about my open-source activities.
*   Write posts about software development.
*   Currently working in [Epam Systems](https://www.linkedin.com/company/epam-systems/)

## 🛠 Technical 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 Modeleter
*   GitHub/GitLab/Gerrit/Bitbucket

### My opensource projects

*   [image-comparison](https://github.com/romankh3/image-comparison) - Published on Maven Central Java Library that compares 2 images with the same sizes 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>
To use static data, you just need to change my username to the desired one. What does it look like in real life? You can view it on your account page . Subscribe, let's reach a THOUSAND subscribers together)

What conclusions can be drawn

In this article, we discussed how to create a resume on Github. This is not a simple resume that we send to the employer, where we scrupulously describe our experience, knowledge of technology, etc. This is where we collect condensed information about ourselves by providing links to profiles on other networks that have other information. Why is that? Because in reality, if they use Github to search for candidates, it is extremely rare. This place is more likely for technical specialists who, in addition to a resume, can also evaluate the applicant in this way. In addition, this summary helps to focus attention on what you consider important. You can take out exactly those repositories that you want to show. And last but not least, this is a good way to use all the capabilities of Github to promote yourself as a specialist. We added the ability to create a resume - why not do it?

Future plans

In addition to the step-by-step polishing of the README.md file, there is one more idea that I have not seen implemented, and I think that it will be useful to others. In addition to the README.md file, I would like to create a project that, given the given data, will generate a normal resume in the required formats: pdf, doc, csv, and so on. And precisely so that when a new commit is added to the master branch, all these documents would be created. How to do it? I don’t know yet, I need to study the issue, but I think it might be interesting and useful for others. In the meantime, thank you all for reading. This is the article we published after a long series of the project from A to Z. And as usual, friends, I suggest you subscribe to my telegram channel : I keep track of all my articles and projects there. See you later.
Comments
TO VIEW ALL COMMENTS OR TO MAKE A COMMENT,
GO TO FULL VERSION