GitHub to jeden z najpopularniejszych portalów programistycznych. Eksploruje go miliony programistów w poszukiwaniu solidnych rozwiązań, a także rekruterzy w odkrywaniu uzdolnionych programistów.
Dziś pokażę Ci kilka prostych zabiegów, które nie zajmują dużo czasu i pozwolą Ci zbudować profesjonalny wizerunek w oczach wszystkich użytkowników GitHuba.
Wielu programistów nie przywiązuje wagę do opisu kodu i profilu z którego upublicznia swój kod. Jednak każdy programistów szukający rozwiązań na repozytorium ceni sobie przejrzystą dokumentację – bo to od niej rozpoczyna pracę z kodem. Dodatkowo dobry opis pozwoli Ci lepiej wypozycjonować się w przeglądarce Google i tym samym dostarczyć Ci znacznie więcej odwiedzin Twojego eksperckiego profilu/udostępnianego repozytorium.
Jest to Twoja wizytówka! Jeśli nie masz strony domowej, to GitHub jest idealnym miejscem by stworzyć miejsce do którego będziesz przekierowywać swoich potencjalnych pracodawców/zleceniodawców lub zacząć budować własną społeczność.
1. Twój profil na GitHub
Domyślnie profil na GitHubie wskazuje informacje na temat Twoich ostatnich projektów oraz częstotliwości udostępnianych zmian.
Profil warto jest podrasować, aby przyciągnąć uwagę innych osób i wyszukiwarek. Swój profil rozbudowałem, w taki sposób aby zawierał on informacje o mnie, mojej specjalizacji, danych kontaktowych i kilku dodatkowych rzeczach:
Żeby mieć możliwość stworzenia własnej, spersonalizowanej strony wystarczy, że utworzysz nowe publiczne repozytorium o nazwie takiej samej jak Twój nick na GitHub.
Możesz od razu zaznaczyć wygenerowanie pliku README.md, w którym zbudujesz swoją własna stronę domową. Najlepsze jest to, że GitHub już na start dostarcza Ci atrakcyjny szablon, który wystarczy uzupełnić swoimi danymi:
Oczywiście nic nie stoi na przeszkodzie, aby pójść dalej i swój profil dużo bardziej rozbudować. W kolejnych punktach wskażę Ci najlepsze narzędzia do jego tworzenia, ale jeśli nie masz czasu to możesz pozostać przy domyślnym lub skopiować plik .md ode mnie. Ciekawym zabiegiem jest również opracowanie w tym miejscu własnego CV!
2. Strona Twojego repozytorium
To dokumentacja Twojego kodu, jednak najlepiej podejść do niego od strony użytkownika. Przede wszystkim powinna zawierać ona informacje:
- Jaki problem rozwiązujesz.
- Jak korzystać z rozwiązania.
- Demo.
Niestety wielu programistów nie przywiązuje wagi do dema. Widziałem mnóstwo wspaniałych projektów, które często są pomijane, bo brakuje w nim prezentacji działania.
Nieraz do uruchomienia bardziej zaawansowanych aplikacji potrzeba zainstalować JRE/npm, zaciągnąć masę pakietów i przystąpić do odpalenia aplikacji. Pytanie czy rekruter będzie tym zainteresowany? 😬
Najlepszym rozwiązaniem jest wyjście na przeciw potrzebom rekrutrów i innych potencjalnym użytkowników, którzy mogą być zainteresowani naszym projektem. Dlatego sposobem na wyróżnienie się jest sprecyzowana sekcja Demo. Mogą być to proste screeny, jednak swoim Studentom z Akademii Spring zawsze polecam zrobienie wideo, które będzie specjalnym wyróżnikiem i jest jednocześnie najprostszym przekazem dla rekrutra.
Takie nagranie umieścił jeden z moich Studentów w pliku REDME.MD
Jego repozytorium i jego aplikacje znajdziesz oczywiście w serwisie GitHub. Sam plik .md można by było rozbudować do dodatkowe wspomniane elementy. Dlatego jako przykład wzorcowego repozytorium polecam Ci github-readme-stats. Posiada ona wszystkie wymieniowe aspekty, o których wspomniałem. Traktuj je jako swój wzór. Tym bardziej, że jest to repozytorium zawierające interaktywne elementy mające na celu uatrakcyjnienie repozytoriów. Dlatego w kolejnym punkcie pokażę Ci jakie narzędzia możesz wykorzystywać do upiększenia swojego README.md.
3. Narzędzia, które urozmaicą Twój README.md
GitHub Readme Stats
Jak wstępnie wspomniałem, narzędzie to pozwala Ci wstawić dynamiczne statystyki dotyczące Twojego repozytorium.
https://github.com/anuraghazra/github-readme-stats
Odznaki technologii (badges)
Chcesz mieć ładne ikonki technologii na swoim profilu?
polecam Ci do tego dwa repozytoria:
https://github.com/Ileriayo/markdown-badges
https://github.com/devicons/devicon
Licznik odwiedzin
Sam nie wdrożyłem, bo dla mnie to bardziej bajer niż wartościowa informacja dla moich odbiorców, jednak może komuś się przyda – często wykorzystywany przez topowych infulencerów 😉
https://github.com/antonkomarev/github-profile-views-counter
Emoji
Pełna lista emotikonek jakie możesz wykorzystwać w markdownie:
https://gist.github.com/rxaviers/7360908
Kanał RSS
Jeśli prowadzisz swojego bloga, możesz również podpiąć kanał RSS, który będzie na bieżąco wyświetlał Twoje ostatnie wpisy na blogu:
https://github.com/gautamkrishnar/blog-post-workflow
Śmietanka na końcu – coś dla bardzo zapracowanych
Redme generator to narzędzie które od początku do końca stworzy Ci w pełni funkcjonalny, graficzny i elegancki profil. Wystarczy podstawić tylko dane:
https://rahuldkjain.github.io/gh-profile-readme-generator/
Kurs Git i GitHub – praktycznie w jeden wieczór
Jeśli chcesz nabrać biegłości w posługiwaniu się Gitem i GitHubem to mam dla Ciebie dobrą wiadomość. Udostępniam zapis z webinaru, który od podstaw przybliży Ci zasady codziennej pracy programisty z tym narzędziem. Dlatego ten 3h materiał dedykowany jest dla osób, które chcą zostać Java Developerami lub chcą uporządkować i poszerzyć zdobytą wiedzę. Ponadto oprócz podstaw pokażę Ci kilka przydatnych hacków oraz wprowadzę w świat wykorzystywania narzędzi na produkcji. Niemniej najciekawszym elementem jest przedstawianie jego działania w połączeniu z IntelliJ. Sprawdź kurs Git i GitHub.
O czym warto pamiętać?
Ostatnią myślą jaką chce Ci przekazać, to zachowanie czytelności. Narzędzi, które urozmaicą Twoje repozytorium jest wiele, jednak wodotryski mogą mieć wręcz odwrotny rezultat. Staraj się przestrzegać trzech kluczowych punktów:
- Jaki problem rozwiązujesz
- Jak korzystać z rozwiązania
- Demo
A w komentarzu pochwal się swoim odpicowanym repozytorium 😉
