Giter VIP home page Giter VIP logo

erlang-guidelines's Introduction

Рекомендации для разработчиков

Work in progress.

Комментарии и PR приветствуются.

Общие сведения

Разработка ведётся под Erlang/OTP версии 18 или выше.

В качестве основного инструмента для сборки, анализа исходного кода и запуска тестов используется rebar3. Рекомендуется использовать GNU Make для автоматизации рутинных операций и организации привычной среды для новых разработчиков.

Управление зависимостями в rebar3 предполагает более тесное использование центрального репозитория пакетов hex.pm, поэтому при поиске подходящих зависимостей следует посетить этот репозиторий в первую очередь.

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

В качестве инструмента статического анализа настоятельно рекомендуется использовать dialyzer и xref.

При подготовке production ready сборок проектов следует использовать функционал релизов, предоставляемый relx.

В качестве CI/CD сервиса используется wercker, который к тому же предоставляет простой инструмент для локальной отладки билдов и запуска переносимой среды для разработки. В процессе сборки на CI сервисе рекомендуется выполнение:

  • сборки;
  • запуска наборов eunit и ct тестов;
  • статического анализа посредством xref и dialyzer.

Безопасность

При разработке ПО важно уделять внимание к подходам, позволяющим сделать это ПО безопасным. Необходимо руководствоваться следующими материалами:

  1. Предотвращение XXE

Для дальнейшего ознакомления

  1. Инструментарий
  2. Структура и шаблоны проектов
  3. Написание исходного кода
  4. Внесение изменений
  5. Работа с системой контроля версий
  6. Подготовка релиза
  7. Версионирование

erlang-guidelines's People

Contributors

jrogov avatar keynslug avatar leksadin avatar petrkozorezov avatar vulnbe avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.