Назад

Як створити хороший профіль на GitHub?

html code

Джерело фото: https://goo.su/RAtXP5H

Коли я, навчаючись у коледжі, подавала заявки на стажування, я безперечно недооцінювала GitHub. За час навчання я створила чимало проектів. Мені навіть довелося до кожного додати докладний опис, який можна було б легко перетворити в README. Тим не менш, я не замислювалась завантажити ці проекти в свій профіль на GitHub і підтримувати їх. Однак згодом (досить швидко) я зрозуміла, що це було втраченою можливістю.

Так, підтримка профілю на GitHub забирає багато часу та сил. Вам доводиться писати не лише код, а й документацію, а потім стежити за старими проектами та оновлювати їх. А коли ви вже перейшли до вивчення інших тем і нових проектів, все це — додаткове навантаження. Але якщо докласти ще трохи зусиль, ваші навчальні чи просто особисті проекти можуть стати значною частиною вашого портфоліо. А портфоліо це фантастичний спосіб виділитися на загальному тлі.

Хто одержує найбільшу користь від проектів на GitHub?

Найбільшу користь проекти, розміщені на GitHub, приносять людям, які вперше шукають роботу. Це студенти університетів, вчорашні випускники та люди, які пройшли навчання на курсах. Вони не мають професійного досвіду у сфері розробки, а тому особисті проекти найкраще можуть показати їхні здібності та вміння. Також наявність проектів на GitHub може стати в нагоді досвідченим розробникам, які бажають змінити роботу. Якщо програміст на поточній роботі не стикається зі складними та цікавими завданнями, якщо йому доводиться писати код «немодними» мовами, такому програмісту буде складно знайти роботу з сучасним технічним стеком. Якщо, звісно, ​​він покаже свій досвід роботи із сучасними технологіями. А можна показати на особистих проектах.

У цій статті я зібрала всі поради щодо покращення профілю на GitHub, які мені давали викладачі у коледжі та наставники. Всі ці рекомендації покликані покращити ваші шанси знайти роботу. Особисто я не претендую на звання суперкористувача GitHub, але закликаю вас наслідувати поради, які опишу тут.

Включайте до кожного репозиторію добре складений README

Документування коду грає величезну роль. І не тільки для користувачів, які намагатимуться скористатися створеними вами інструментами. Це важливо ще й для рекрутерів та менеджерів по найму, які переглядатимуть ваш профіль. Якщо у ваших репозиторіях буде добре відформатована документація, це покаже, що ви:

  1. 1. Маєте гарні навички комунікації.
  2. 2. Думаєте про те, що важливо для проекту у довгостроковій перспективі.

Складаючи документацію, обов'язково вказуйте призначення вашого проекту та варіанти його використання. Також слід увімкнути інструкції зі встановлення, щоб користувачі могли легко запустити та використовувати будь-який створений вами інструмент. Нарешті, додайте до документації демо (скриншоти чи гіфки — додатковий плюс!) або посилання на демо, щоб користувачі могли без проблем подивитися, як все працює.

Пишіть чистий, добре організований код

Джерело: https://goo.su/qJeIzWV

Вміння писати чистий код - обов'язкова навичка для роботи в команді. Коли члени команди або менеджери бачать у кандидата код, з яким їм було б проблемно працювати, це часто відвертає їх від цього кандидата. Як і хороший файл README, добре організований код — чудовий спосіб справити прекрасне враження. Створюйте функції для коду, що повторюється, і підчищайте код за допомогою лінтерів - це частина кращих підходів. Включайте до свого коду коментарі — за необхідності або відповідно до загальноприйнятої практики для вашої мови. Наприклад, у Python слід прописувати Docstrings у функціях.

Намагайтеся не перестаратися з коментарями. Щоб усунути зайві коментарі, постарайтеся підібрати змінним осмислені імена і максимально спростити сам код (уникайте занадто хитромудрих прийомів). Ваші коментарі мають більше фокусуватися на цілі написання коду. І, звичайно, у вас має бути хороша файлова структура у проекті. Наприклад, якщо ви маєте багато допоміжних функцій, намагайтеся зберігати їх в окремому файлі. І не забувайте написати тести для свого коду.

Підтримуйте активність

Джерело: https://goo.su/EIiapGo

Ваші квадратики мають бути зеленими! Це показник вашої активності на платформі та постійної роботи з кодом, а з погляду менеджерів за наймом це плюс. Загальне правило таке: оновлюйте свій код і робіть коміти частіше. Працюєте над навчальним проектом? Поновлюйте репозиторій у міру просування. До речі, у маленьких проектах немає нічого поганого. Головне, стежте за тим, щоб вони були різними та демонстрували різні навички.

Оновлюйте ваші проекти. У міру того, як у вас будуть з'являтися нові знання та навички, ви зможете вносити зміни до своїх старих проектів або робити оновлення. Окрім комітів із змінами, ви можете робити й інші речі для підтримки активності на GitHub. Наприклад:

  1. 1. Відкривати issue.
  2. 2. Пропонувати пул-реквест.
  3. 3. Робити рев'ю пул-реквестів.

У вас на роботі також використовується GitHub? Ви можете включити Private contributions, щоб ваша активність відображалась у вашому профілі.

Джерело: https://goo.su/k2Qiz9

Використовуйте GitHub Pages

GitHub Pages — чудовий інструмент, що дозволяє розмістити веб-сторінку прямо з репозиторію. Таким чином ви зможете моментально показати користувачеві результат вашого проекту. Наприклад, якщо ваш проект — це сайт, вам потрібно лише натиснути кілька кнопок, і GitHub Pages розмістить вашу сторінку index.html. Більше того, будь-які зміни, які ви запустите, позначаться на розміщеній сторінці навіть без будь-якого розгортання. Наявність демо чи домашньої сторінки проекту може мати ключове значення для демонстрації ваших навичок. Якщо не знаєте, як розмістити демо, зверніть увагу на GitHub Pages: це чудовий варіант.

Інформація про вас, вказана у профілі

Щоб ваш профіль приносив вам користь, потрібно включити інформацію про себе і контактні дані. Рекрутери використовують інструменти пошуку, щоб знаходити профілі кандидатів у певній локації, тому вказівка вашого розташування допоможе їм знайти вас. Також може допомогти додати посилання на інші ваші профілі. Щоб одразу справити гарне враження на відвідувачів, ви можете відібрати свої найкращі проекти та закріпити ці репозиторії на сторінці.

Джерело: https://goo.su/Uz3J

Не забувайте, що профіль на GitHub - це не резюме. Для рекрутерів та менеджерів по найму якість вашого профілю це додатковий матеріал до вашої заявки на вакансії та тема для обговорення на співбесіді. Не вважайте, що ваш профіль універсальний інструмент на всі випадки життя.

Інші поради

  1. 1. Не нехтуйте можливістю додати опис та теги до своїх репозиторіїв. При цьому будьте стислі та інформативні.
  2. 2. Виявляйте професіоналізм під час написання назв комітів. Пишіть щось більш осмислене, ніж "fix bug" або "why won't this work??" («Чому це не працює??»).
  3. 3. Якщо передбачається, що інші люди можуть стати контриб'юторами вашого проекту, обов'язково напишіть чітке керівництво, як їм це зробити.
  4. 4. Видаліть зайве, наприклад форки репозиторіїв, над якими ви не працювали.
  5. 5. Беріть активну участь у житті спільноти, наприклад, станьте контриб'ютором у проектах з відкритим кодом.

Висновок

Дотримуючись цих порад, я змогла перетворити свій профіль GitHub на корисний інструмент для пошуку роботи. На співбесідах мені ставили питання про мої проекти (отже, рекрутери переглядали профіль). Я всім рекомендую користуватися GitHub як інструментом для пошуку роботи або навіть просто для забезпечення своєї присутності онлайн. Успіхів!