Путь простого 1С-ника в мир продвинутых средств разработки тернист...
Иногда, после многих часов разбирательства по той или иной теме, возникает желание усвоенную информацию сохранить в сжатом и удобном виде. Как для себя в будущем, так и для других.
Кроме того, используя ссылки на статьи данного репозитория в других проектах, появляется возможность быстро организовать документацию по введению контрибьюторов в специфику.
Затрагиваемые темы, в основном, касаются:
- стандарты разработки на платформе 1С:Предприятие;
- продвинутая IDE для 1С:Предприятия Enterprise Development Tools (1C:EDT);
- работа с git, GitHub.
Обычно, изучение документации специалистами, работавшими только в IDE Конфигуратор, по этим вопросам связано с непреодолимой болью, так как:
- Документация может вообще отсутствовать на русском языке;
- Ошибки Eclipse/EDT, недокументированное поведение;
- Документация слишком сложно и широко написана, на контрасте с узко-специализированными задачами для нужд разработки 1С.
Самое сложное - это сделать первый шаг. Поэтому, статьи раздела прежде всего концентрируются на установке программ и правильной начальной настройке окружения, оставляя ссылки на официальные источники информации для более глубокого самостоятельного изучения в дальнейшем процессе работы.
Базовая инструкция и терминология git
Установка git
Подпись коммитов
Установка gpg
Настройка связи git и gpg
Консолидация правил, которых я стремлюсь придерживаться при разработке собственных проектов на платформе 1С:Предприятия.
Каждый мой проект по умолчанию использует данный репозиторий как code-style и источник стандартов. Если в проекте приняты отклонения от этих общих стандартов, спецификацию можно найти в файле "code of conduct" репозитория проекта. Если на проекте допускается открытая или совместная разработка, эти стандарты распространяются на всех контрибьюторов.
Этот репозиторий используется мной и моими коллегами в нашей непосредственной работе по разработке и сопровождению конфигураций клиентов, обучении стажеров, в качестве удобного референса на конкретные ошибки. Репозиторий оформлен таким образом, что не привязан жестко к конкретной компании, однако может содержать персонализированные практики (в некоторых разделах).
При формировании используются источники:
- Официальная библиотека документации фирмы 1С;
- Диагностики BSL LS - проекта автоматизированного анализа качества кода и метаданных;
- Осмысленный опыт разработки/доработки в типовых конфигурациях (личный и моих коллег).
Ключевые правила:
- Основополагающими стандартами считаются стандарты из официальной библиотеки.
- Данный репозиторий в основном дублирует/консолидирует официальные стандарты, не переопределяя их и не противореча им.
- В редких случаях переопределения типовых стандартов, статья должна содержать достаточную доказательную базу целесообразности нарушения официального стандарта.
- В некоторых случаях допускается формирование мягких стандартов, принимающих несколько решений как допустимые.
Каждый, кто непосредственным образом повлиял на формирование стандартов обладает большим опытом (5 лет и более) активной разработки/доработки в типовых решениях фирмы 1С на управляемых формах, включая обширный опыт обновления таких конфигураций.
Стандарты подчиняются единой системе нумерации, определенной как:
<номер раздела или предметной области>.<номер стандарта>, без лидирующих нулей и пробелов
Разделы и стандарты внутри них формируются в естественном порядке очередности попадания в данный репозиторий.
Ниже представлено оглавление по разделам стандартов, каждая из ссылок позволяет легко выполнять навигацию до конкретной статьи.
Чтобы сослаться на конкретный стандарт в тексте, который допускает форматирование (добавление представлений ссылкам), достаточно указать номер стандарта в качестве представления. Таким же образом следует ссылаться на стандарты в устной речи.
Абсолютная ссылка на любой стандарт формируется как:
https://github.com/L32GIT/workflow-guides/tree/main/docs/std/<номер стандарта>
Все статьи вне зависимости от раздела располагаются в одном подкаталоге репозитория /docs/std/
Еще не сформировано.