diff --git a/Abstract-Issue.md b/Abstract-Issue.md index d9a6736..2835421 100644 --- a/Abstract-Issue.md +++ b/Abstract-Issue.md @@ -1,61 +1,61 @@ -# Issue - -## title -// describe the principles and format; - -## description -// describe the principles and format; - -Issue -- это этруктурированная задача c типизированными данными: - -## type - -| Parameter | Value | -| --- | --- | -| **Exclusive** | true | -| **Namespace** | type, f.e. `type/bug` | - -это тип задачи по структуре и наполнению, но в первую очередь - по ценности для бизнеса -- `bug` -- проблема, в существующем коде; -- `task` -- имплементация нового функционала; -- `refactor` -- задачи на рефакторинг: перемещения файлов, архитектурные принципы и пр. -- `test` -- задачи по написанию/исправлению тестов; -- `feature` -- контейнер для нескольких issues с единой бизнес-ценностью; -- `draft` -- ишью с недостаточно описанной задачей; - -## tech - -| Parameter | Value | -| --- | --- | -| **Exclusive** | false | -| **Namespace** | tech, f.e. `tech/obs`, `tech//postgres` | - -это задачи привязанные к конкретной техонологии: - -- sql (pgx, sqlc, sql-migrate...) -- persistent storage; -- obs (grafana, loki, prometheus, alloy,...) -- observability; -- ... - -## severity - -| Parameter | Value | -| --- | --- | -| **Exclusive** | true | -| **Namespace** | `severity`, f.e. `severity/low` | - -Options: severity/{low|medium|high|showwstopper|critical} - -это значение влияния выполнения на бизнес ценность - -## component - -| Parameter | Value | -| --- | --- | -| **Exclusive** | false | -| **Namespace** | `comp`, f.e. `comp/appclick` | - -это компонент системы репозитория, пресета не существует, зависит от проекта. - -## dependencies - -один issue может зависеть от других явно через поле depends on: {issue-1}, {issue-2} \ No newline at end of file +# Issue + +## title +// describe the principles and format; + +## description +// describe the principles and format; + +Issue -- это структурированная задача c типизированными данными: + +## type + +| Parameter | Value | +| --- | --- | +| **Exclusive** | true | +| **Namespace** | type, f.e. `type/bug` | + +это тип задачи по структуре и наполнению, но в первую очередь - по ценности для бизнеса +- `bug` -- проблема в существующем коде; +- `task` -- имплементация нового функционала; +- `refactor` -- задачи на рефакторинг: перемещения файлов, архитектурные принципы и пр. +- `test` -- задачи по написанию/исправлению тестов; +- `feature` -- контейнер для нескольких issues с единой бизнес-ценностью; +- `draft` -- ишью с недостаточно описанной задачей; + +## tech + +| Parameter | Value | +| --- | --- | +| **Exclusive** | false | +| **Namespace** | tech, f.e. `tech/obs`, `tech/postgres` | + +это задачи привязанные к конкретной технологии: + +- sql (pgx, sqlc, sql-migrate...) -- persistent storage; +- obs (grafana, loki, prometheus, alloy,...) -- observability; +- ... + +## severity + +| Parameter | Value | +| --- | --- | +| **Exclusive** | true | +| **Namespace** | `severity`, f.e. `severity/low` | + +Options: severity/{low|medium|high|showstopper|critical} + +это значение влияния выполнения на бизнес ценность + +## component + +| Parameter | Value | +| --- | --- | +| **Exclusive** | false | +| **Namespace** | `comp`, f.e. `comp/appclick` | + +это компонент системы репозитория, пресета не существует, зависит от проекта. + +## dependencies + +один issue может зависеть от других явно через поле depends on: {issue-1}, {issue-2}