Стандартизация кода, документ и ответственная роль?

Question

[lukoie]

Допустим в начале какого-то большого проекта собралась команда, и принимают решения по архитектуре, и в частности по унификации и стандартизации написания кода. Например, кемелКейс или БЭМ. Где ставится { , 8 или 4
Ну вот такая мелочь, например.
Кто вообще за такие детали должен отвечать в идеале(правильно ли я думаю что QC?), и как будет называться такой документ, где будет всё такое выписано?

ЗЫЖ я помнб читал такой документ, но я забыл где и какой конторы, где были выписаны такие детали, и там было в статье расказано кто и как его принимал. Может знаете о какой статье я говорю?

Comments

[lukoie]

что-то вот такое выгуглил, "соглашение" - вроде адекватное название документа
https://pythonworld.ru/osnovy/pep-8-rukovodstvo-po...

[lukoie]

такое еще нашел, по пхп. тут оно уже "стайл гайд"
https://www.php-fig.org/psr/psr-12/

[lukoie]

мелкий частный пример www.finar.ru/Base/CodeStyle
Вики о стандартах вообще: https://ru.wikipedia.org/wiki/%D0%A1%D1%82%D0%B0%D...

Answer 1

[Александр Докин]

Для разных языков существуют свои стандарты. Просто гуглите что-то вроде {language} style guides. Например для php это будут PSR, для js например гайд от airbnb или ideomatic.js.

Когда вы пользуетесь общепринятыми стандартами написания кода, все проще. В линтерах эти style guides априори уже есть. Внутри команды вы просто договариваетесь, каким будете следовать. Если хотите использовать что-то свое - расшариваете для членов команды кастомные конфиги.

Как называется такой документ? Наверное Code Style Guide. Возможно вы говорите о статье https://www.pullrequest.com/blog/create-a-programm...
Там же есть синонимы: coding guidelines, coding standards, or coding conventions.

Кто контролирует? Хорошо, если есть несколько уровней проверки кода:

• уровень разработчика - с помощью линтера в среде разработки кода
  
• уровень тимлида/старшего разработчика - в ходе выполнения кодревью
  
• уровень хендлеров в системе контроля версий - при выполнении push или merge (не прошло - получаем отказ)
  

Answer 2

[uvelichitel]

кемелКейс, 8 или 4

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

Comments

[lukoie]

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

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

[uvelichitel]

lukoie, я имел ввиду не команду вообще, а именно разработчиков языка программирования который вы используете и его стандартных библиотек. Пинает linter, которые уже сложились для большинства распространенных языков. Для продуктовых разработчиков лучше, мне кажется, просто использовать готовые стандарты, чем велосипедить свои. Допустим упомянутый вами PEP8 создан на основе рекомендаций Гуидо ван Россума с добавлениями от Барри, диктаторов разработки языка Python. PEP8 - это design document, style guide. Русские переводы никакие еще не прижились, а в советской инженерной школе были - методические указания.))

[SVM]

сам то понял,что скаэал