Кава-брейк #46. 5 способів покращити якість коду, працюючи в команді розробників. Рекомендації для фрілансерів-початківців

5 способів покращити якість коду в команді розробників

Джерело: ITnext Коли розробники об'єднуються в одну команду, зазвичай виникає проблема, пов'язана з якістю коду. Якщо розробник працює над проектом один, йому не варто особливих труднощів поліпшити якість свого коду. У команді це буває набагато складніше. Ми розглянемо, що впливає на якість коду і які є способи підвищити цю якість у команді.

Що таке якість коду?

Кодування – це не лише готові програми. Звичайно, це головний результат, але внутрішній пристрій коду також важливий. Поганий код призводить до появи поганих програм, що негативно відбивається на користувачах. Якість коду — це термін, який використовується для опису того, наскільки читабельним, зрозумілим, упорядкованим та обслуговуваним є вихідний код. Читання та впорядкованість впливають на розуміння та ремонтопридатність коду. Зрозумілість коду є важливим фактором у роботі команди, оскільки як нинішні, так і майбутні розробники програми повинні легко розуміти код, написаний іншим розробником. Код називається "обслуговується", коли його частину можна легко змінити, видалити або поліпшити. Якщо якість коду низька, на підтримку коду може знадобитися більше часу. Це веде до постійної втрати часу. Тепер, коли ви знаєте, що така якість коду та його переваги, давайте розглянемо кілька способів його покращення.

П'ять стратегій підвищення якості коду

1. Короткі коментарі до кодів

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

// get all user's posts
const getUsersPosts = () => {
...
}

Як можна помітити, коментар дуже схожий на назву функції. Навіть без функції ми можемо зробити висновок, що повідомлення збираються з бази даних. Ось коментар краще:

// check DB to confirm if ticket exists
// all the required information for tickets are available
const verifyTicket = id => {
...
}

Просто прочитавши verifyTicket , важко пояснити, що відбувається. Але якщо ви побачите поданий вище коментар, зрозуміти, що відбувається всередині коду, стає набагато легше. Таким чином, навіть коли буквальна реалізація коду є важкою для сприйняття, хороші коментарі спрощують пояснення реалізації. Якщо ваша команда не використовує або мало використовує коментарі, ви маєте стати ініціатором впровадження цієї практики. Десь це може здатися недоречним (можливо через рівень досвіду ваших колег), але ви не будете вічно працювати з однією і тією ж групою людей, тому важливо виробити звичку використовувати короткі коментарі.

2. Використовуйте ефективні інструменти налагодження

Інструменти налагодження, такі як Postman , Visual Studio Code , RubyMine , Rookout та інші, придумали, щоб полегшити життя командам розробників. Використання console.log, додавання контрольних точок у DevTools та інші подібні методи – це добре, але недостатньо. Rookout трохи схожий на редактор. Зрозуміло, він не замінить вашу IDE, але містить функції, що спрощують налагодження. Ви можете підключити Rookout до свого працюючого додатку, додати контрольні точки (не зупиняючи реалізацію коду), контролювати та керувати своїм додатком, а також отримати аналітичні дані щодо його роботи. За наявності засобів налагодження якість коду підвищується, оскільки основна увага в середовищі розробки приділяється коду програми, а не коду налагодження. Крім того, налагодження в онлайн-режимі покращує безпеку, якщо над кодом працює велика група розробників.

3. Складіть посібник із стилю

Єдиність коду багато в чому сприяє його зручності читання. У різних розробників різні переваги. Деякі воліють одинарні лапки подвійним лапкам. Деякі вважають за краще робити чотири пробіли замість двох прогалин. Деякі використовують одні правила замість інших. Оскільки всі ці розробники роблять свій внесок у той самий код, ви часто виявите змішання стилів і переваг у різних файлух проекту. Маючи посібник зі стилю, кожен розробник, як учасник проекту, змушений дотримуватися специфікацій стилю проекту. Щоб зробити це ефективно, існують такі інструменти, як ESLint та Prettier . ESLint можна інтегрувати у різні IDE. Після визначення правил стилю проекту у файлі конфігурації ESLint вкаже на помилки в рядках коду, які не відповідають посібнику за стилем. Як видно вище, ESLint вказує на помилки та відображає повідомлення. Використовуючи цей метод, можна переконатися, що код вашої команди відповідає стандартам. Prettier також може бути інтегрований у різні IDE. На відміну від ESLint, який свідчить про помилки, Prettier цього робить. Однак Prettier можна використовувати для форматування файлу, він виправлятиме кожний рядок коду відповідно до встановленого стилю.

4. Перевірте код

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

5. Правильно називайте змінні

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

Рекомендації для фрілансерів-початківців

Джерело: Live Code Stream Тенденція до роботи вдома набирає обертів після того, як пандемія коронавірусу зупинила більшість підприємств. І хоча це не нова концепція роботи, але останнім часом люди все частіше шукають способів заробити гроші в інтернеті. Ви можете почати займатися фрілансом або навіть працювати самостійно. Сподіваюся, що ця стаття допоможе вам стати на правильний шлях.

Зосередьтеся на своїх навичках

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

Використовуйте ключові слова, щоб знайти

Якщо ви вже вибрали навичку для надання послуг фрілансера, тепер ви можете запропонувати багато видів послуг для кожної навички. Наприклад: Але найголовніше, що якщо клієнт шукає фрілансера, а ваш профіль або послуга не відображаються в результатах пошуку, він, ймовірно, ніколи вас не знайде. Отже, ви не отримаєте жодної роботи. Отже, основна ідея помістити свій профіль або послугу в результати пошуку. Дуже важливо, щоб інформація про вас завжди була на увазі. Це покращить шанси, що клієнти вас знайдуть. Щоб інформація про вас з'явилася в інтернеті, ви маєте провести широке дослідження ключових слів. Цілком нормально, якщо вам доведеться витратити на це кілька днів. На цьому етапі вам допоможе базове розуміння SEO. Якщо ви не знайомі з концепціями просування в пошукових системах, я рекомендував би її вивчити. Оскільки ви тільки починаєте, ваша основна мета – знайти ключові слова для послуг, над якими ніхто не працює або які мають дуже низьку конкуренцію. Це дозволить вам легко ранжуватися за ключовими словами з низькою конкуренцією. З ключовими словами, які мають високу конкуренцію, це буде набагато складніше. Також не забувайте підбирати високоприбуткові ключові слова. Це означає, що люди повинні бути готові витрачати гроші на замовлення ваших послуг. Немає причин витрачати час на послуги, які ніхто не шукає.

Виберіть два або три майданчики для фрілансерів

Нещодавно я опублікував статтю про найкращі сайти для фрілансерів . Спробуйте подивитися на неї та виберіть дві або три платформи для початку. Основною перевагою бірж фрілансерів є те, що вони діють як брокери, що значно знижує можливість шахрайства в порівнянні з прямою взаємодією з клієнтами. Настав час створити привабливі профілі на цих платформах. По суті ви повинні надати детальну інформацію про свої послуги, а також показати привабливе портфоліо. Деякі платформи не дозволяють відображати портфоліо. Тому в цьому випадку просто покажіть свої попередні зразки роботи клієнтам, коли вони зв'яжуться з вами. Причина, через яку ви працюєте лише на двох або трьох сайтах, полягає в тому, що так ви можете легко керувати робочим навантаженням. Згодом ви зможете розширити цей список. Але краще почати з малого.

Як встановлювати ціни?

Ви маєте стежити за своїми конкурентами. Дізнайтесь, що вони пропонують і за якою ціною. Це допоможе вам визначити, скільки роботодавці зазвичай готові платити за послуги. Спочатку встановлюйте нижчу ціну, ніж конкуренти. Дозвольте клієнтам вивчити вашу роботу перед тим, як підвищувати ставку.

Пошук потенційних клієнтів у соціальних мережах

Оскільки ви тільки починаєте, вам буде складно реалізувати свій перший проект. Я рекомендую знаходити клієнтів у соціальних мережах та укладати з ними договори через біржу фрілансерів. Для цього поділіться своїм профілем чи послугою у соціальних мережах. Наприклад, на Facebook є багато груп, де люди шукають певні таланти. Так само LinkedIn також може бути чудовою нагодою для зв'язку з потенційними клієнтами. Спочатку ви повинні викластися на повну і виконати величезний обсяг роботи. Але це швидко окупиться, коли ви почнете постійно заробляти.

Забезпечуйте якісний результат

Найкраще у фрілансі це те, що немає обмежень на те, скільки ви можете заробити за один день, місяць або рік. Якщо ви ставитеся до цього як до бізнесу, у вас буде багато можливостей для зростання. Єдина вимога – ви повинні надати вашим клієнтам результат високої якості. Я виявив, що відгуки/огляд/рейтинг з боку клієнтів є найважливішим фактором, який допомагає займати більш високі позиції в результатах пошуку на майданчиках для фрілансерів. Якщо клієнти вражені вашою роботою, вони обов'язково поставлять вам хороші оцінки. У свою чергу це збільшить ваші шанси отримати роботу у майбутніх замовників. Іноді потрібно попросити замовника залишити свій відгук після того, як проект виконано. Але це можливе лише в тому випадку, якщо він буде задоволений вашою роботою. Завжди пам'ятайте, що хороший зворотний зв'язок/рейтинг клієнтів — це ключ до успіху у фрілансі!

Керуйте часом ефективно

Фрілансери швидко губляться, коли починають виконувати постійну роботу. У цей вирішальний момент у гру вступають ваші навички тайм-менеджменту. На відміну від денної роботи, фріланс – це не робота з 09:00 до 17:00. Але ви самі собі бос, так що цілком можливо, якщо ви створите розклад і дотримуватиметеся його.

Висновок

Під час пандемії COVID-19 робота фрілансером стала особливо зручною. Я б сказав, що ви вчинабо правильно, вибравши фріланс як кар'єру. Це може дати вам більш високе джерело доходу, ніж ваша поточна робота.