Перейти до основного вмісту

Найменування договору

Цей документ визначає стандартну угоду про іменування для кодової бази SiMa.ai Neat.

Канонічні імена​

  • Назва продукту: SiMa.ai Neat
  • Проєкт CMake: SimaNeat
  • Простір імен C++: simaai::neat
  • Основні типи середовища виконання: Model, Graph, Run.

До загальнодоступних об’єктів належать наземні споруди.​

Використовуйте заголовки в розділі include/ як загальнодоступне джерело істини.

Приклади:

#include "model/Model.h"
#include "pipeline/Graph.h"
#include "pipeline/Run.h"

Застарілі псевдоніми​

Застарілі назви підтримуються лише як посилання для забезпечення сумісності та як посібники з міграції.

  • PipelineSession -> Graph
  • PipelineRun -> Run
  • NeatModel -> Model
  • InputAppSrc -> Input
  • OutputAppSink -> Output

Не створюйте нові загальнодоступні документи/приклади, використовуючи застарілі символи.

Політика​

  • Нова документація, призначена для користувачів, повинна використовувати стандартні назви.
  • Застарілі терміни дозволяється використовувати лише в примітках до міграції, коментарях щодо сумісності або чітко позначені розділи, що містять інформацію про застарілі функції.
  • Система безперервної інтеграції забезпечує це за допомогою scripts/ci/check_naming_and_conflicts.sh.