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

Writing a resume on GitHub. Brief guide

Published in the Random EN group
Hi all. The A to Z series of articles on the Java project has come to an end, which means that you can now write about all the other interesting topics. Today we will talk about how to create a resume on GitHub. In the process of finding a job (and especially the first job), all methods are good, and shrugging off one of them is clearly not a good idea. Writing a resume on GitHub - 1In addition, this is an excellent continuation of the development strategy of your GitHub account, which serves as a developer's portfolio and contains the necessary information about it. In a word, this is a useful step for the development of your technical brand. This post can be considered a continuation of articles about experience with GitHub, improving your profile, learning features (before that, I wrote about Git and about setting up repositories on GitHub). In general, I find this approach (summary 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 the saying goes, Rome was not built overnight. Following this idea, writing a resume should start as early as possible. Yes, at first it will not be possible to indicate many years of commercial experience. However, there is always something to say about yourself. And the summary is just the place to talk about it. Even if at first it will be written: I am Vasya Pupkin, a novice Java developer. I know Java SE. My contacts: ... ... And then, already in the process of learning, gaining some experience, you will add new details to the resume. Passed 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 building a resume

The first thing to do is to create a new repository with the same name as username on GitHub. I will show all this with my example: Writing a resume on GitHub - 2As you can see from the message on the light green plate, we are on the right track. All summary information will be in the README.md file of this project. We create a repository and return to the profile page, there we will see the README of this project at the top: Writing a resume on GitHub - 3So far there is only Hi there , but a start has been made. Now it's time to fill this file. If you start editing it, you will notice a 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 a 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 kind of education (maybe more than one), specialized courses, volunteering experience and much more, which is really important to tell. Therefore, here, on the github, there should be the most sustained information with links to social networks where you can get more data.

Add links to social media profiles

Now it's time to add links to social media profiles that would complete all the information about us. For this case, we will use the shields.io service , which has the ability to add icons for our links. There you can add a YouTube channel and Twitter and more. Also full statistics on github. Who cares, it's really worth adding. There is also an option to add an icon for the BTC wallet. This can be used as a means for donations, because a normal sponsorship solution directly through github has not been delivered to Ukraine, Russia, Belarus ... Which, by the way, is a shame. I want to add my email, LinkedIn link and Telegram channel link. I did not find this here, so I will use another turnip on github - alexandresanlim / Badges4-README.md-Profile. It has everything I needed and even 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 I try to place it wherever possible (those who have been reading me for a long time, I think, have already noticed this :D);
  • Gmail is the email address where you can contact me. I try not to shine too much with my personal telegram account in order to keep it as a means of personal communication. And mail is clear and suitable for communication with everyone.
I would like to somehow highlight the Telegram channel, but have not yet figured out how to do it beautifully and out of place. As a result, 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 the experience and data about yourself. So we will try to do just that. At the first iteration of creation, my page didn’t look like a compact one at all: Writing a resume on GitHub - 5So now I will try to make it even smaller ... I will work on it some more. By the way, this is a working approach when we gradually refine some 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 paragraph, I added the statistics on the github account that I took in 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 spread in the use of programming languages. It is also useful to watch how the profile codebase changes, especially if you start learning some new programming language. After several dances with HTML markup, it turned out to set two statistics to the same width, a line, and centered this matter by 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 dice so that they were on the same line. Set height = 150. A cool thing is the counter of the number of profile views. Not very informative, but cool. Let there be at least some statistics on the number of profile views. Yes, I know that it is not as informative as we would like, but what is it. Therefore, at the end we add such a 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 - 6Already better, right?)) Next, let's add the logos of the technologies that we would like to show. Again, it will take a lot of time to expose everything at once, so you can follow this step by step. I will skip this step simply because the time spent on the article has already come out) As a result, we get the following resume 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/codegymcommunity) 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.
*   [CodeGym TelegramBot](https://github.com/codegymcommunity/codegym-telegrambot) - CodeGym 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. How does it look live? You can see it on the account page . Subscribe, let's reach THOUSANDS of 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, and so on. This is where we collect compressed information about ourselves by providing links to profiles on other networks that have the rest of the information. Why is that? Because in reality, if they use github to search for candidates, it is extremely rare. This place is rather for technical specialists who, in addition to the resume, can also evaluate the applicant in this way. In addition, this summary helps to focus 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 features of github to promote yourself as a specialist.

Future plans

In addition to step-by-step polishing of the README.md file, there is another idea that I have not seen in the implementation, 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, according to the given data, will generate a normal summary in the required formats: pdf, doc, csv, and so on. And just 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, we need to study the issue, but I think that it can be interesting and useful for others. In the meantime, thank you all for reading. This is how we came out with an article after a long series of projects from A to Z. And as usual, friends, I suggest subscribing to my telegram channel : I keep track of all my articles and projects there. See you later.Writing a resume on GitHub - 7
Comments
TO VIEW ALL COMMENTS OR TO MAKE A COMMENT,
GO TO FULL VERSION