Какова наилучшая практика кодирования и когда ее создавать?

Лучшая практика кодирования — это конкретное действие в конкретном контексте, это способ делать что-то для достижения определенного результата. Эти методы различаются между компаниями, а иногда даже между командами внутри одной компании.

К сожалению, редко когда инструменты статического анализа (линтеры) могут автоматически идентифицировать все эти приемы кодирования, выходящие за рамки синтаксиса кода. Вот почему так важно, чтобы вся команда была на их стороне.

Имея это в виду, мы создали Promyze, решение, которое объединяет лучшие практики кодирования вашей команды.

Практика кодирования в Promyze состоит из:

• имя
• описание
• категории
• примеры кода (положительные, отрицательные и рефакторинг)

Зачем определять лучшие практики кодирования и делиться ими?

Поскольку компании стремятся как можно быстрее приносить пользу и избегать ошибок, которые наносят ущерб их бизнесу, они должны извлекать выгоду из коллективного разума всех своих команд.

Accelerate в своем исследовании подчеркнул, что наиболее успешные компании с точки зрения ИТ внедрили Культуру обучения, которая способствует непрерывному обучению и обмену знаниями. Это помогает справиться в основном с:

• Неоднородность навыков в командах — каждый может учиться на навыках своих коллег и тем самым укреплять навыки команды в целом.
• Текучесть — новички могут быстро ознакомиться с практикой компании, что сокращает время адаптации и риск потери навыков при уходе.
• Быстро развивающиеся технологии — передовой опыт постоянно обновляется, регулярно появляются новые языки и платформы, поэтому важно быть в курсе последних событий. Более того, на личном уровне это позволяет разработчикам оставаться конкурентоспособными на постоянно развивающемся рынке.

Когда создавать лучшие практики кодирования?

Чтобы вся команда могла внести свой вклад в этот обмен знаниями, каждый должен иметь в виду, «когда» он может создать практику.

Чтобы не покидать рабочую среду, это должно происходить во время написания кода (из вашей IDE) или при ревью кода (например, на мерж-реквесте в GitLab).

Плагины Promyze упрощают это создание, позволяя команде создавать эти практики за считанные секунды.

2 основных сценария должны привести к созданию лучших практик:

• Выявлена ​​ошибка, связанная с плохим дизайном или ошибкой кода;
• Внесено улучшение в исходный код

Обнаружена ошибка, связанная с плохим дизайном или ошибкой кода.

«На своих ошибках всегда нужно учиться».

Тесно связанный с подходом Dantotsu, идея состоит в том, чтобы использовать каждую ошибку в качестве источника обучения. Каждая проблема затем представляется команде, и в результате этих обсуждений могут возникнуть одна или несколько практик.

Очевидно, это также верно и для потенциальных ошибок, которых можно было бы избежать, например, если они были обнаружены во время проверки кода; в этом случае плагины Promyze позволяют вам создать эту практику напрямую, когда вы добавляете комментарий во время проверки кода.

Например: в компоненте AngularJS обнаружена ошибка, при уничтожении компонента должно было произойти отключение.

А вот связанное с этим исправление, чтобы следовать рекомендациям.

Внесено улучшение в исходный код

Поскольку исходный код постоянно развивается, наша практика постоянно подвергается сомнению. Когда практика развивается, редко можно изменить весь исходный код продукта, чтобы следовать ей. Поэтому в одном и том же исходном коде часто можно найти много разных способов выполнения действий.

Когда практика развивается, она должна быть представлена ​​всей команде, и это изменение должно быть где-то зафиксировано. В противном случае это только локально и не длится с течением времени.

Эти изменения практики могут иметь разную природу, например:

• В кодовую базу вводится новая концепция

Добавление новой системы в приложение для вызова при добавлении нового объекта.

• Улучшения в архитектуре кода

Настройка нового шаблона для выделения уровня инфраструктуры.

Пример с устаревшим соглашением.

• Улучшения производительности, безопасности и специальных возможностей
• Улучшения ремонтопригодности (например, лучшая читаемость исходного кода).

Конечно, мы могли бы перечислить еще несколько, но эти четыре примера — основные, которые заставят вашу команду начать делиться лучшими практиками кодирования.

Подведение итогов

В заключение, очень важно поделиться внутри команды практиками, чтобы улучшить время выполнения и снизить коэффициент неудачных изменений. >». Технические руководители должны быть драйверами и послами этого подхода, чтобы повысить вовлеченность остальной команды.