Інструкція з оформлення профілю на GitHub
Джерело фото: https://goo.su/pWpTCf
Правильно оформлений профіль на GitHub дуже важливий для пошуку роботи: для інтерв'юера це єдина можливість побачити ваш код та оцінити вас у справі.
GitHub – це обличчя програміста. Портфоліо демонструє як ваші технічні навички, так і soft skills: вміння піклуватися про користувача, писати документацію та інші корисні в командній роботі навички. В інструкції я зібрав 10 правил та 7 пасток GitHub, які потрібно знати кожному програмісту, який хоче знайти хорошу роботу.
10 правил оформлення профілю на GitHub
Хороша фотографія
Помітна фотографія, що добре читається, допомагає розташувати до вас відвідувача профілю. Вибирайте знімок з обличчям крупним планом та нейтральним фоном.
Ім'я та прізвище
Обов'язково напишіть своє ім'я та прізвище, а не тільки нікнейм, щоб профіль легко було порівняти з резюме.
Адреса електронної пошти
Переконайтеся, що e-mail для зв'язку з вами доступний всім. Для цього зайдіть в налаштування профілю: там є спеціальна кнопка "зробити публічним". Уникайте адрес у дусі sexybaby@gmail.ua - використовуйте ящик у доменній зоні.com зі зрозумілим неймінгом. Не робіть публічним email, який прив'язаний до вашого облікового запису GitHub: це підвищує ймовірність злому облікового запису і демонструє слабке володіння правилами безпеки в інтернеті.
Біографія
Багато хто ігнорує цей розділ, а дарма. Напишіть трохи про те, якими технологіями займаєтесь і що вам цікаво. Тоді той, хто переглядає ваш код, розумітиме, на що дивитися.
Посилання на соцмережу
Додайте посилання на професійну соцмережу, яку ви ведете найбільш активно та докладно.
Репозиторії
Прикріплюйте лише ті репозиторії, які хочете показати майбутньому роботодавцю. Видаліть «дитячі» проекти! Нікому не цікаво дивитися на Hello, world!. Якщо репозиторія ще немає, зробіть проект самі: створіть чат-бот або простий додаток про погоду — що допоможе побачити вас у справі.
Турбота про читача
Інтерв'юеру важко: щодня він дивиться десятки профілів, тому опишіть кожен проект якомога зрозуміліше. Хороший спосіб - поставити перед назвами проектів емодзі, які допоможуть відразу зрозуміти суть проекту: наприклад, джойстик для гри або штепсель з ножем для сервісу бронювання столиків.
README
Обов'язково зробіть файл Readme усередині проекту. Опишіть проект одним реченням, а потім розкажіть в одному абзаці про те, яку мету ставили, що робить ваша розробка і таке інше. Так ви покажете рекрутеру вміння формулювати думки та писати документацію та продемонструєте, що працювати з вами буде легко.
Команда
Якщо ви робили проект разом із командою, виявіть повагу: додайте посилання на репозиторії інших авторів проекту.
Візуалізація
Ідеально, якщо вам вдасться прикріпити до проекту гіфку або відео, яке показує, як все працює.
7 пасток GitHub - помилки в оформленні, які часто роблять програмісти
Неочевидна команда запуску
Напишіть код, який запускає вашу програму. Деякі програмісти вважають, що npm init і npm start - це очевидні команди, але не варто забувати про те, що очевидне вам зовсім не обов'язково буде зрозуміло тому, хто читає ваш проект.
Сміття у коді
Заберіть консоль-логи, принти, висновки помилок і дурні коментарі. Якось я співбесідував на посаду викладача приємного кандидата і вже збирався запропонувати йому роботу. А потім виявив у його коді функцію, яка не робила нічого. Поруч із нею красувався коментар: «Треба видалити».
Помилки в коді
Обов'язково проженіть код через лінтер: він перевірить код на помилки, вкаже на баги та знайде підозрілі конструкції.
Ключі та паролі в коді
Не залишайте у ваших репозиторіях ключі та паролі – це поганий тон. Зберігайте такі дані в змінних оточення або в .env-файлі, додавши його в .gitignore.
Незрозумілі коміти
Починайте свій коміт із того, що ви щось додали, видалили чи змінили. Потім напишіть, що сталося в результаті. Перевірте себе: читаючи добрий коміт, стороння людина може зрозуміти, що було зроблено і навіщо. Наприклад: змінили функцію, яка не дозволяла надіслати листа.
Низька активність
Дуже важливо постійно тримати зеленим ваш графік активності (contributions). Щоб не створювалося враження, що ви не працюєте, створіть спеціальну папку «Мої алгоритми». Додайте до неї всю релевантну активність: «Алгоритм рішення судоку», «Алгоритм сортування», щоб було видно, що Ви постійно щось робите.
Поганий стиль
Дотримуйтесь стайлгайду своєї мови - PEP8 для Python, Airbnb Style Guide для JavaScript, Airbnb Ruby Styleguide для Ruby і так далі. Так ви продемонструєте турботу про комфорт колег та повагу до прийнятих у співтоваристві норм.
Сподіваємось Вам допомогла ця стаття :)
Джерело: https://goo.su/0UKtp
Редактор: Аліна Берестень
Адміністратор: Дмитро Берестень