Skip to content

Latest commit

 

History

History
29 lines (16 loc) · 1.14 KB

File metadata and controls

29 lines (16 loc) · 1.14 KB

Migration Rules

Purpose

Цей документ задає правила змін schema після v1.

Rules

1. Не змінювати існуючий contract мовчки

Якщо змінюється форма MemoryDocument, LinkRef, TaskItem або Provenance, це має фіксуватися окремим schema version.

2. Піднімати schema_version

Зміни, що ламають сумісність, вимагають нового schema_version.

3. Не змішувати v1 і майбутні v2 правила без явного переходу

Validator та adapters повинні знати, з якою версією schema вони працюють.

4. Міграція має включати три частини

  • опис, що змінилося;
  • правила перетворення старих docs;
  • список перевірок після міграції.

5. Canonical docs мігруються першими

Починати потрібно з root nodes, canonical concepts, decisions, contexts і indexes, а не з випадкових notes.