конвенции отделены от обвязки
- сами конвенции переехали в conventions/, описательное — в корень: LANGUAGE.md (язык записи) и GUIDE.md (как ведут конвенции) - conv синхронизирует только conventions/, пути в origin даются относительно неё — раскладка копий в репозиториях не меняется
This commit is contained in:
@@ -5,6 +5,20 @@
|
||||
`ansible-roles`: канон не источник истины во время работы, а лавка, из
|
||||
которой берут и в которую возвращают улучшения.
|
||||
|
||||
Сами конвенции лежат в `conventions/`, обвязка — в корне:
|
||||
|
||||
| Файл | Что описывает |
|
||||
|---|---|
|
||||
| `README.md` | устройство канона, оси, синхронизация, жизненный цикл |
|
||||
| [LANGUAGE.md](LANGUAGE.md) | язык записи правил: номера, модальность, «Почему» |
|
||||
| [GUIDE.md](GUIDE.md) | как ведут конвенции: когда заводить, механизация, отступления |
|
||||
| `conv` | синхронизация копий |
|
||||
|
||||
Обвязка живёт только в каноне и в репозитории не оказывается — `conv`
|
||||
синхронизирует лишь содержимое `conventions/`. Пока это осознанное
|
||||
ограничение: копия конвенции ссылается на `LANGUAGE.md` как на внешний
|
||||
документ.
|
||||
|
||||
Правило то же, что у ролей: **деплоится и читается только то, что лежит в
|
||||
git репозитория**. Канон никем не подключается на лету.
|
||||
|
||||
@@ -30,12 +44,16 @@ git репозитория**. Канон никем не подключаетс
|
||||
## Оси
|
||||
|
||||
```
|
||||
common/ как вести сами конвенции
|
||||
arch/ решения, переживающие смену языка и инструментов
|
||||
lang/<язык>/ как решение реализуется и механизируется в языке
|
||||
stack/<стек>/ привязка к инструменту, хранилищу, транспорту
|
||||
conventions/
|
||||
arch/ решения, переживающие смену языка и инструментов
|
||||
lang/<язык>/ как решение реализуется и механизируется в языке
|
||||
stack/<стек>/ привязка к инструменту, хранилищу, транспорту
|
||||
```
|
||||
|
||||
Пути правил даются относительно `conventions/`: адрес
|
||||
`arch/db-identifiers.md R5`, а не `conventions/arch/…` — так же, как они
|
||||
лягут в `docs/conventions/` репозитория.
|
||||
|
||||
Тест — по тому, замена чего убивает правило:
|
||||
|
||||
> Умирает при смене **языка** → `lang/`. Умирает при смене **инструмента,
|
||||
|
||||
Reference in New Issue
Block a user