Compare commits
15
Commits
a45d3e77b9
..
v0.1.4
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
add9e5f638 | ||
|
|
a818889e54 | ||
|
|
803f0843f8 | ||
|
|
1378ac9fe2 | ||
|
|
04dc662b2e | ||
|
|
c24e4b990a | ||
|
|
602eb43294 | ||
|
|
eaf7ede841 | ||
|
|
fe99b05e93 | ||
|
|
e6fd4f64b8 | ||
|
|
4caa5e92b7 | ||
|
|
2c34023af8 | ||
|
|
f0cab445d7 | ||
|
|
df6f0109ed | ||
|
|
0f8bbee10a |
@@ -0,0 +1,15 @@
|
||||
---
|
||||
name: Bug Report
|
||||
about: Неверное поведение
|
||||
---
|
||||
# Bug Report
|
||||
|
||||
## Проблема и шаги воспроизведения
|
||||
|
||||
## Факт / ожидание
|
||||
|
||||
## Acceptance Criteria
|
||||
|
||||
- [ ]
|
||||
|
||||
## Окружение / ссылки (если применимо)
|
||||
@@ -0,0 +1,13 @@
|
||||
---
|
||||
name: Engineering Task
|
||||
about: CI, тесты, документация, процесс и прочее
|
||||
---
|
||||
# Engineering Task
|
||||
|
||||
## Контекст и результат
|
||||
|
||||
## Scope / связанные Issues (если есть)
|
||||
|
||||
## Acceptance Criteria
|
||||
|
||||
- [ ]
|
||||
@@ -0,0 +1,15 @@
|
||||
---
|
||||
name: Feature Request
|
||||
about: Новое наблюдаемое поведение
|
||||
---
|
||||
# Feature Request
|
||||
|
||||
## Зачем и какой результат
|
||||
|
||||
## Ожидаемое поведение
|
||||
|
||||
## Acceptance Criteria
|
||||
|
||||
- [ ]
|
||||
|
||||
## Зависимости / связанные Issues (если есть)
|
||||
@@ -0,0 +1,15 @@
|
||||
---
|
||||
name: Refactoring / Technical Debt
|
||||
about: Улучшение без нового поведения
|
||||
---
|
||||
# Refactoring / Technical Debt
|
||||
|
||||
## Проблема и результат
|
||||
|
||||
## Сохраняемые инварианты / границы
|
||||
|
||||
## Acceptance Criteria
|
||||
|
||||
- [ ]
|
||||
|
||||
## Зависимости / ссылки (если есть)
|
||||
@@ -0,0 +1,19 @@
|
||||
# Pull Request
|
||||
|
||||
## Summary
|
||||
|
||||
Краткий результат работы описывается здесь.
|
||||
|
||||
## Linked Issue
|
||||
|
||||
Refs `<owner/repo#number>` (заменить ссылкой на реальную Issue).
|
||||
|
||||
## Changes
|
||||
|
||||
Затронутые части и изменения.
|
||||
|
||||
## Verification
|
||||
|
||||
- Команда / результат / ограничения:
|
||||
|
||||
## Breaking Changes (если есть)
|
||||
@@ -2,7 +2,11 @@ name: Conventional commits
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
types: [opened, synchronize, reopened, edited]
|
||||
types: [opened, synchronize, reopened]
|
||||
|
||||
concurrency:
|
||||
group: docs-commits-${{ gitea.event.pull_request.number }}
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
commits:
|
||||
@@ -23,4 +27,8 @@ jobs:
|
||||
HEAD_SHA: ${{ github.event.pull_request.head.sha }}
|
||||
run: |
|
||||
printf '%s\n' "$PR_TITLE" | npm run commitlint -- --strict
|
||||
npm run commitlint -- --strict --from "$BASE_SHA" --to "$HEAD_SHA"
|
||||
if [[ "$PR_TITLE" =~ ^chore\(release\):\ [0-9]+\.[0-9]+\.[0-9]+$ ]]; then
|
||||
npm run commitlint -- --strict --from "$HEAD_SHA^" --to "$HEAD_SHA"
|
||||
else
|
||||
npm run commitlint -- --strict --from "$BASE_SHA" --to "$HEAD_SHA"
|
||||
fi
|
||||
|
||||
@@ -2,12 +2,16 @@ name: Docs security
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- '**'
|
||||
branches: [develop, main]
|
||||
pull_request:
|
||||
types: [opened, synchronize, reopened]
|
||||
schedule:
|
||||
- cron: '17 5 * * *'
|
||||
|
||||
concurrency:
|
||||
group: docs-security-${{ gitea.event_name }}-${{ gitea.event.pull_request.number || gitea.ref }}
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
security:
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
@@ -2,8 +2,13 @@ name: Docs verify
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: ['**']
|
||||
branches: [develop, main]
|
||||
pull_request:
|
||||
types: [opened, synchronize, reopened]
|
||||
|
||||
concurrency:
|
||||
group: docs-verify-${{ gitea.event_name }}-${{ gitea.event.pull_request.number || gitea.ref }}
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
verify:
|
||||
|
||||
@@ -3,6 +3,9 @@
|
||||
Перед изменением прочитай [README](README.md) и [CONTRIBUTING](CONTRIBUTING.md),
|
||||
затем только затронутую тему. Docs объясняет систему; требования принадлежат
|
||||
основным спецификациям, реализация и coding conventions — соседним репозиториям.
|
||||
До edits найди/создай подходящую Gitea Issue, проверь AC и ветку; чтение
|
||||
допускается без Issue. Общий маршрут — [Engineering Workflow](https://git.personal.ksv741.ru/WealthLedger/main/src/commit/03b3b59e6ff2ba391f9dfc42a039a96d0d84c1c9/.ai/conventions/engineering-workflow.md)
|
||||
(main#28; после merge — актуальная версия `develop`).
|
||||
|
||||
Проверь существенные факты по локальным тематическим страницам и ADR;
|
||||
внешние источники используй как справочные свидетельства, когда они доступны.
|
||||
@@ -20,7 +23,8 @@
|
||||
|
||||
## Ветки и релизы
|
||||
|
||||
Работа — в отдельной ветке от `develop`, затем PR в `develop`; в `main` напрямую
|
||||
Работа — в issue-linked ветке от `develop`, затем PR в `develop`; в `main` напрямую
|
||||
не пушить. Release/hotfix и синхронизация веток — по [README](README.md#релизы).
|
||||
Commits и заголовки PR — Conventional Commits; для спецификаций допустим `spec:`.
|
||||
Commits и заголовки PR — Conventional Commits со ссылкой на Issue (кроме release);
|
||||
для спецификаций допустим `spec:`.
|
||||
Перед подготовкой релиза прочитай местный README; версии вручную не повышать.
|
||||
|
||||
@@ -1,5 +1,29 @@
|
||||
# Changelog
|
||||
|
||||
## [0.1.4](https://git.personal.ksv741.ru/WealthLedger/docs/compare/v0.1.3...v0.1.4) (2026-10-12)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* align docs commitlint workflow (WealthLedger/main[#27](https://git.personal.ksv741.ru/WealthLedger/docs/issues/27)) ([602eb43](https://git.personal.ksv741.ru/WealthLedger/docs/commit/602eb43294509274cbd9003be31f726b6e275a1e))
|
||||
|
||||
### Documentation
|
||||
|
||||
* clarify card summary totals ([df6f010](https://git.personal.ksv741.ru/WealthLedger/docs/commit/df6f0109ed696a529cf2622e23fceeab8133f932))
|
||||
* document hourly attempt lifecycle semantics (WealthLedger/backend[#56](https://git.personal.ksv741.ru/WealthLedger/docs/issues/56)) ([1378ac9](https://git.personal.ksv741.ru/WealthLedger/docs/commit/1378ac9fe2fcfd43bd71421e62b02f00069be928))
|
||||
* document hourly investment reads ([f0cab44](https://git.personal.ksv741.ru/WealthLedger/docs/commit/f0cab445d7e7076bf92a61f1023b8bf51e094d33))
|
||||
* document hourly sync history ([e0bceea](https://git.personal.ksv741.ru/WealthLedger/docs/commit/e0bceea936239c08f4717e264be23d7f60552398))
|
||||
* document stock screener ([2c34023](https://git.personal.ksv741.ru/WealthLedger/docs/commit/2c34023af8593f305f7c81e672b4e179c0992cf3))
|
||||
* pin docs workflow reference (WealthLedger/main[#27](https://git.personal.ksv741.ru/WealthLedger/docs/issues/27)) ([c24e4b9](https://git.personal.ksv741.ru/WealthLedger/docs/commit/c24e4b990aaeffd02e05f7de21942579e452cecf))
|
||||
|
||||
### CI
|
||||
|
||||
* avoid duplicate PR checks ([4caa5e9](https://git.personal.ksv741.ru/WealthLedger/docs/commit/4caa5e92b7d2597e5c7725b2036007b71ece2abd))
|
||||
* skip checks on PR metadata edits ([e6fd4f6](https://git.personal.ksv741.ru/WealthLedger/docs/commit/e6fd4f64b81dd73b33959b845a1babcfac1891c8))
|
||||
|
||||
### Maintenance
|
||||
|
||||
* align docs engineering workflow (WealthLedger/main[#27](https://git.personal.ksv741.ru/WealthLedger/docs/issues/27)) ([eaf7ede](https://git.personal.ksv741.ru/WealthLedger/docs/commit/eaf7ede8414f0df972f9ae7ab9e223a6350b5462))
|
||||
|
||||
## [0.1.3](https://git.personal.ksv741.ru/WealthLedger/docs/compare/v0.1.2...v0.1.3) (2026-10-07)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
@@ -35,7 +35,7 @@ WealthLedger помогает частному инвестору понимат
|
||||
| [Операции](domains/operations/overview.md) | Исполненные операции, фильтры и пагинация |
|
||||
| [Доход](domains/income/overview.md) | Полученные купоны и дивиденды, периоды и состав расчёта |
|
||||
| [Будущие выплаты](domains/income/upcoming-events.md) | Календарь по текущим позициям и ограничения прогноза |
|
||||
| [Акции](domains/instruments/stocks.md) и [облигации](domains/instruments/bonds.md) | Поиск выпуска, рыночные показатели и личная история |
|
||||
| [Скринер акций](domains/instruments/stocks.md) и [облигации](domains/instruments/bonds.md) | Подбор акций по параметрам, поиск выпуска, рыночные показатели и личная история |
|
||||
|
||||
## Найти материал по задаче
|
||||
|
||||
@@ -72,9 +72,11 @@ WealthLedger помогает частному инвестору понимат
|
||||
## Релизы
|
||||
|
||||
Репозиторий выпускается независимо. `develop` — интеграция, `main` — принятые
|
||||
релизы. Работа: `codex/<task>` от актуального `develop`, PR в `develop`.
|
||||
релизы. Обычная работа: issue-linked ветка от актуального `develop`, PR в `develop`;
|
||||
общие правила — в Engineering Workflow по ссылке из AGENTS.
|
||||
Обычные PR допускают squash; release и обратная синхронизация сохраняют историю.
|
||||
Commits и PR titles — Conventional Commits, включая `spec:`. Версии вручную не повышай.
|
||||
Commits и PR titles — Conventional Commits со ссылкой на Issue (кроме release),
|
||||
включая `spec:`. Версии вручную не повышай.
|
||||
|
||||
1. Получи `main`, `develop` и теги: `git fetch origin --tags`. Убедись, что
|
||||
`develop` содержит последний релиз. Создай `release/<name>` от проверенного
|
||||
|
||||
@@ -29,6 +29,14 @@ completeness, `lastSuccessfulAt`, `lastAttempt` и availability. Первые,
|
||||
результату. `lastAttempt` описывает относящуюся к ресурсу часовую попытку:
|
||||
`none`, `running`, `succeeded`, `partial` или `failed`.
|
||||
|
||||
Итог попытки выводится из фактических результатов её шагов: попытка, не
|
||||
завершившая обязательный шаг, не обозначается полным успехом, а полученные
|
||||
успешные результаты сохраняются. Ожидание каждого шага ограничено; зависший
|
||||
шаг учитывается проблемным, а начатое обращение к T-Bank не отменяется.
|
||||
Попытка, потерявшая выполнение после сбоя сохранения или остановки процесса,
|
||||
закрывается частичным успехом либо неуспехом и не блокирует следующий обход
|
||||
дольше обычного часового срока.
|
||||
|
||||
Поздняя неуспешная или частичная попытка сохраняет прежний полный результат и
|
||||
его исходное время. Если полного результата нет, `data` равно `null`: состояние
|
||||
availability объясняет первоначальную загрузку, временную недоступность либо
|
||||
|
||||
@@ -21,6 +21,17 @@ artifact у себя и проверяет соответствие generated ty
|
||||
API имеет prefix `/api/v1`; Swagger публикуется для локальной разработки по
|
||||
environment policy, а не используется frontend в runtime.
|
||||
|
||||
## Скринер акций
|
||||
|
||||
`POST /api/v1/stocks/screener/search` всегда создаёт новый результат по
|
||||
условиям скринера, включая пустой подтверждённый список. Ответ первой страницы
|
||||
содержит непрозрачный `searchId`, время получения каталога и признак следующей
|
||||
страницы. `GET /api/v1/stocks/screener/search/{searchId}?page=...` читает
|
||||
последующую страницу того же результата, не запускает новый поиск и сохраняет
|
||||
состав и время списка. Идентификатор результата принадлежит текущему пользователю
|
||||
и его подключению; недоступный или чужой результат возвращает ошибку, а не
|
||||
пустой список. Точные поля и статусы определяет backend-generated OpenAPI.
|
||||
|
||||
## Инвестиционные данные и синхронизация
|
||||
|
||||
Затронутые GET инвестиционных ресурсов возвращают сгенерированный contract
|
||||
|
||||
@@ -1,4 +1,12 @@
|
||||
module.exports = {
|
||||
extends: ["@commitlint/config-conventional"],
|
||||
rules: { "type-enum": [2, "always", ["feat", "fix", "perf", "docs", "spec", "refactor", "build", "ci", "test", "style", "chore", "revert"]] },
|
||||
defaultIgnores: false,
|
||||
ignores: [
|
||||
message => /^chore\(release\): \d+\.\d+\.\d+$/.test(message.trim()),
|
||||
message => /^Merge pull request ['"].+['"] \(#\d+\) from .+ into .+$/.test(message.trim()),
|
||||
],
|
||||
rules: {
|
||||
"type-enum": [2, "always", ["feat", "fix", "perf", "docs", "spec", "refactor", "build", "ci", "test", "style", "chore", "revert"]],
|
||||
"references-empty": [2, "never"],
|
||||
},
|
||||
};
|
||||
|
||||
@@ -28,24 +28,29 @@
|
||||
на frontend. Общее для акций и облигаций восстановление справочных данных
|
||||
принадлежит [загрузке портфеля на backend](../portfolio/flows/portfolio-loading.md).
|
||||
|
||||
Раздел «Акции» в боковой и мобильной навигации ведёт на `/stocks`: поиск
|
||||
по названию или тикеру через каталог Т-Банка, начиная с двух символов.
|
||||
Результаты разных выпусков, включая обыкновенные и привилегированные акции,
|
||||
имеют отдельные UID. Карточка результата показывает логотип, последнюю цену
|
||||
с её временем, тип бумаги, площадку, код режима, ISIN и доступность торгов через
|
||||
API. Поиск показывает одну карточку на нормализованный ISIN. До ограничения
|
||||
в 30 результатов выбирается представитель выпуска: доступность через API,
|
||||
точное совпадение тикера, затем режим TQBR; равные варианты упорядочены по UID.
|
||||
Записи без ISIN сохраняются отдельно по UID. Обыкновенные и привилегированные
|
||||
акции с разными ISIN не объединяются. Цена и ссылка принадлежат выбранному
|
||||
UID; данные разных режимов не смешиваются. Прямые ссылки из портфеля сохраняют
|
||||
Раздел «Акции» в боковой и мобильной навигации ведёт на `/stocks`: скринер
|
||||
запускается кнопкой «Найти» с необязательным названием или тикером, сектором,
|
||||
типом акции, валютой расчётов, площадкой, страной риска и максимальным размером
|
||||
лота. Он использует полный полученный каталог и показывает только акции, для
|
||||
которых каталог подтверждает доступность покупки и торговли через API. Это не
|
||||
гарантирует, что конкретная заявка пользователя будет исполнена прямо сейчас.
|
||||
|
||||
Скринер показывает одну карточку на выпуск с нормализованным ISIN, а выпуск
|
||||
без ISIN остаётся отдельной карточкой точного UID. Обыкновенные и
|
||||
привилегированные акции с разными ISIN не объединяются. После отбора карточки
|
||||
упорядочены по тикеру и UID, разделены на страницы по 30 и показывают единое
|
||||
время получения списка. Изменение условий не заменяет текущий список до
|
||||
следующего нажатия «Найти». Повторный поиск получает новый каталог; страницы
|
||||
одного результата не пересчитываются. Подтверждённый пустой результат отличается
|
||||
от ошибки источника, для которой интерфейс предлагает повторить поиск.
|
||||
|
||||
Ссылка карточки принадлежит выбранному UID; данные разных режимов не смешиваются.
|
||||
Прямые ссылки из портфеля сохраняют
|
||||
исходный UID, даже если поиск выбрал другой режим этого выпуска; такая страница
|
||||
сохраняет UUID в адресе. Если один точный тикер относится к разным выпускам,
|
||||
сервер возвращает `409 STOCK_TICKER_AMBIGUOUS`, а страница предлагает поиск.
|
||||
Поиск тикера нечувствителен к регистру, но использует точное совпадение:
|
||||
SBER не заменяется на SBERP. Однобуквенные тикеры также поддерживаются.
|
||||
сервер возвращает `409 STOCK_TICKER_AMBIGUOUS`.
|
||||
Прямая ссылка не требует предварительного открытия портфеля. Хлебные крошки
|
||||
«Акции → название» возвращают к поиску.
|
||||
«Акции → название» возвращают к скринеру.
|
||||
|
||||
## Содержание и состояния
|
||||
|
||||
@@ -144,10 +149,11 @@ TTM означает последние 12 месяцев, MRQ — послед
|
||||
## Получение данных и ограничения
|
||||
|
||||
Общие metadata, discovery, company, quotes, свечи и календари сохраняются
|
||||
в SQLite. Поиск хранит подтверждённый набор UID для конкретного query;
|
||||
успешный SBER не подтверждает пустой GAZP. Отсутствующее enrichment не
|
||||
скрывает найденную бумагу. Сохранённые общие источники переиспользуются
|
||||
между пользователями, но личные позиции и выплаты всегда проверяют доступ.
|
||||
в SQLite. Скринер получает каталог online и показывает время его получения;
|
||||
временная недоступность каталога не подтверждает отсутствие подходящих акций.
|
||||
Отсутствующее enrichment не скрывает найденную бумагу. Сохранённые общие
|
||||
источники переиспользуются между пользователями, но личные позиции и выплаты
|
||||
всегда проверяют доступ.
|
||||
|
||||
Обычное чтение не ждёт RPC; missing/stale зависимости запрашиваются в фоне
|
||||
через существующий T-Bank limiter. Минутная свежесть применяется к quotes
|
||||
|
||||
@@ -128,6 +128,14 @@ Instrument обогащают отображение Position или Event, но
|
||||
|
||||
_Не использовать_: бумага, тикер, актив позиции.
|
||||
|
||||
## Скринер акций
|
||||
|
||||
Подбор выпусков акций по заданным условиям из каталога T-Bank с указанием
|
||||
времени получения списка. Скринер отличается от текстового поиска конкретного
|
||||
инструмента, личного портфеля и подтверждения исполнимости сделки.
|
||||
|
||||
_Не использовать_: гарантия покупки, личная проверка доступа к сделке.
|
||||
|
||||
## Instrument Logo
|
||||
|
||||
Имя файла бренда T-Bank для отображения Instrument в интерфейсе;
|
||||
|
||||
+12
-1
@@ -20,6 +20,12 @@ T-Bank определяет исходные данные и права token. B
|
||||
сессию, выбирает подключение её пользователя и устанавливает доступ к счёту.
|
||||
Наличие идентификатора счёта в URL этого доступа не подтверждает.
|
||||
|
||||
Скринер акций получает полный online-каталог акций T-Bank для каждого нового
|
||||
поиска. В него входят только инструменты, для которых каталог подтверждает и
|
||||
доступность покупки, и торговли через API. Эти признаки описывают полученный
|
||||
снимок каталога: они не подтверждают личные права пользователя, состояние торгов
|
||||
или исполнение будущей заявки. Скринер не использует личный портфель как каталог.
|
||||
|
||||
[MOEX](moex.md) и [НКР](nkr.md) дополняют публичные сведения об облигациях; они не заменяют
|
||||
брокера как источник личных позиций и исполненных выплат. Границы источников
|
||||
показаны в [контексте](../architecture/context.md), смысл дополнений — в
|
||||
@@ -91,7 +97,12 @@ sequenceDiagram
|
||||
|
||||
`INVALID_TBANK_TOKEN` означает отказ внешней аутентификации или прав доступа.
|
||||
`TBANK_UNAVAILABLE` сообщает о временной или иной upstream-ошибке, включая
|
||||
исчерпание очереди. Ответы и ошибки не содержат token. Удаление подключения
|
||||
исчерпание очереди. Диагностические причины жизненного цикла часовой попытки
|
||||
(`INTERRUPTED` — прерывание до нормального завершения, `DEADLINE` — истечение
|
||||
ограничения ожидания шага) не относятся к ошибкам T-Bank: они остаются
|
||||
внутренней диагностикой и не раскрываются в hourly-read. Истечение ограничения
|
||||
ожидания не отменяет уже начатые обращения к T-Bank; их поздние результаты
|
||||
остаются в строках шагов. Ответы и ошибки не содержат token. Удаление подключения
|
||||
идемпотентно: удаляются локальный секрет, личные datasets и work; поздняя
|
||||
публикация прежней revision запрещена. Общие неперсональные источники могут
|
||||
сохраняться. Оно не описывает отзыв token на стороне T-Bank.
|
||||
|
||||
+1
-1
@@ -24,7 +24,7 @@ WealthLedger — локальное приложение для частного
|
||||
| Посчитать полученные выплаты | [Пассивный доход](domains/income/overview.md): исполненные купоны и дивиденды за календарный период |
|
||||
| Посмотреть ожидаемые события | [Будущие выплаты](domains/income/upcoming-events.md): купоны, дивиденды, погашения и оферты по текущим позициям |
|
||||
| Увидеть общий состав инвестиций | Режим [«Все счета»](domains/portfolio/all-accounts.md), сохраняющий принадлежность строк к счетам |
|
||||
| Изучить конкретный инструмент | Поиск и страницы [акций](domains/instruments/stocks.md) и [облигаций](domains/instruments/bonds.md): рынок, личная позиция, история и события |
|
||||
| Изучить конкретный инструмент | [Скринер акций](domains/instruments/stocks.md) по параметрам каталога, страницы акций и поиск [облигаций](domains/instruments/bonds.md): рынок, личная позиция, история и события |
|
||||
|
||||
## Как связаны представления
|
||||
|
||||
|
||||
Generated
+2
-2
@@ -1,12 +1,12 @@
|
||||
{
|
||||
"name": "wealth-ledger-docs",
|
||||
"version": "0.1.3",
|
||||
"version": "0.1.4",
|
||||
"lockfileVersion": 3,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "wealth-ledger-docs",
|
||||
"version": "0.1.3",
|
||||
"version": "0.1.4",
|
||||
"devDependencies": {
|
||||
"@commitlint/cli": "21.2.2",
|
||||
"@commitlint/config-conventional": "21.2.2",
|
||||
|
||||
+1
-1
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "wealth-ledger-docs",
|
||||
"version": "0.1.3",
|
||||
"version": "0.1.4",
|
||||
"private": true,
|
||||
"engines": {
|
||||
"node": "24.21.0"
|
||||
|
||||
Reference in New Issue
Block a user