Skip to main content

Code Standard and Process

Порядок розробки, вимоги до коду, система назв/ naming, якості, code review, документації

  • Треба тести і тестити
  • Документація на все API, Function, Component
  • Максимально розділені проекти - changelog, readme, version, main-
  • Через MR
  • Не додавати нічого нового і не змінювати без документації

QA Test​

  • перевірка параметрів - API, Vue, Function
  • перевірка доступу до файлів - API
  • параметризовані запити - Node
  • заборона exec - Node
  • робота через мікросервіси - Node
  • naming
  • логування - logger.file
  • hardcode
  • eslint перевірка коду
  • unit test
  • документація коду, документація змін
  • Code Review - MR
  • Безпека - правила для параметрів, sql, xss тестування, status code, доступ до чутливої інформації або помилок
  • Ручне тестування - перевіряй що ти робиш і що можеш зламати
  • Code Style + naming convention - Airbnb https://github.com/airbnb/javascript
  • JSDoc
  • Коментар в jira - документацію, коментар, скрін

Вимоги щодо документації​

Результати розробка відразу фіксуються в документації, що є не від'ємною частиною проекту

Порядко розробки проекту і вихідні дані​

Документація інтерфейс API, ERD створюється на початку і є вихідними даними для VUE та інтерфейсів

Система назв​

  • Naming: Давати назви важко, тому добре мати чіткі вказівки.
  • Термінологія: Ознайомлення з поняттями системи та її ієрархією.
  • Git Commit Style: Описано як правильно писати повідомлення до коміту змін.
  • Naming Conventions AirBnb
✏️ Note

використовуйте загально приняту міжнародну/англійську класфиікацію і термінлогію

Принципи​

  • Дизайн з реальними даними
  • Дизайн система, а не дизайн сторінок
  • Краще взагалі не робити, ніж робити не якісно або костиль
  • Проконсультуватись завжди
  • Сумніваєшся не роби
  • Робиш з базою попередньо зроби бекап
  • Оновлювати треба все, а не рядок перевіряти залежності
  • Тестуй