From d17570712d792f58fd6831ac20d4e7311463a3d3 Mon Sep 17 00:00:00 2001 From: Arsen Date: Sun, 19 Oct 2025 16:26:19 +0300 Subject: [PATCH 1/3] chore: fix markdown style to satisfy markdownlint --- README.md | 38 +++++++++-------- content/comm_plan.md | 18 +++----- content/interview_protocol.md | 13 ++---- content/questionnaire.md | 79 ++++++++++++++--------------------- docs/approvals.md | 13 +++--- docs/contribution.md | 33 +++++++-------- docs/process.md | 18 ++++---- 7 files changed, 90 insertions(+), 122 deletions(-) diff --git a/README.md b/README.md index 0d833ac..3f460f6 100644 --- a/README.md +++ b/README.md @@ -1,45 +1,47 @@ # STOP_AI — BDBB - **Краткое описание** -STOP_AI — приложение для безопасного и конфиденциального блокирования LLM‑сервисов на всех платформах. Блокирует сайты и приложения, не хранит историю (только локальный счётчик промптов), поддерживает «жёсткий режим» и опциональную облачную синхронизацию. - - -**Статус**: Документация и CI настроены. GitHub Pages: (будет после деплоя) +STOP_AI — приложение для безопасного и конфиденциального блокирования +LLM-сервисов на всех платформах. Блокирует сайты и приложения, не хранит +историю (только локальный счётчик промптов), поддерживает «жёсткий режим» +и опциональную облачную синхронизацию. ## Структура репозитория -- `docs/` — процесс работы, правила вкладов, политика аппрувов -- `content/` — анкета, протокол интервью, план коммуникаций -- `.github/` — шаблоны PR, CODEOWNERS, workflow'ы +- `docs/` — процесс работы, правила вкладов, политика аппрувов. +- `content/` — анкета, протокол интервью, план коммуникаций. +- `.github/` — шаблоны PR, CODEOWNERS, workflow'ы. ## Как работать (быстро) -1. Fork / Clone: `git clone git@github.com:/STOP_AI.git` -2. Создайте ветку: `git checkout -b feature/` -3. Сделайте изменения, `git add` → `git commit -m "feat: ..."` -4. Push и создайте PR в `main`. -5. Требуется **3** апрува и зелёный CI для мержа. +1. Fork / Clone: + `git clone git@github.com:raijin57/STOP_AI.git` +2. Создайте ветку: + `git checkout -b feature/` +3. Сделайте изменения: + `git add .` → `git commit -m "feat: ..."` +4. Push и создайте PR в `main`. +5. Для мержа требуется **3** апрува и зелёный CI. ## Команда + **Исполнители (BDBB):** + - Дулаев Арсен Аланович — `@raijin57` - Брынцев Андрей Вячеславович — `@AndreyBry` - Карнаухов Глеб Андреевич — `@karnaukhovGA69` - Дмитриев Иван Владимирович — `@IvanDmitriev1` - **Заказчик (SnkrHSE):** + - Курюкин Егор Сергеевич - Черкесов Азамат Заурович - Рыбаков Даниил Андреевич -- Крайнов Григорий Николаевич +- Крайнов Григорий Николаевич` - Макеев Всеволод Сергеевич - ## Ссылка на Pages -(будет автоматически опубликована: https://.github.io/STOP_AI/) +Будет автоматически опубликована после первого успешного деплоя. ---- diff --git a/content/comm_plan.md b/content/comm_plan.md index bba73a5..c861d0f 100644 --- a/content/comm_plan.md +++ b/content/comm_plan.md @@ -1,20 +1,12 @@ # Communication Plan - ## Каналы -- GitHub Issues: основной канал для задач и багрепортов -- Email: для официальных писем и договоренностей -- Telegram: быстрые сообщения +- GitHub Issues: основной канал для задач и багрепортов. +- Email: для официальных писем и договорённостей. +- Telegram: быстрые сообщения. ## Частота отчетов -- Еженедельно — статус-рапорт (1 стр.) -- После каждого спринта — демонстрация результатов - - -## Ответственные -- Менеджер проекта: -- Технический лидер: - ---- +- Еженедельно — статус-рапорт (1 стр.). +- После каждого спринта — демонстрация результатов. diff --git a/content/interview_protocol.md b/content/interview_protocol.md index d309659..74b2bfa 100644 --- a/content/interview_protocol.md +++ b/content/interview_protocol.md @@ -1,23 +1,18 @@ # Interview Protocol — STOP_AI - **Дата:** **Участники (команда BDBB):** **Участники (SnkrHSE):** - ## Цели встречи -- -- +- Уточнить приоритеты по платформам. +- Согласовать политику конфиденциальности и хранения данных. ## Вопросы и ответы -(заполняется после встречи — фиксируйте дословно или кратко с пометками) - ## Action Items -- [ ] (Имя) — выполнить (задача) — срок -- [ ] (Имя) — выполнить (задача) — срок +- [ ] (Имя) — выполнить (задача) — срок. +- [ ] (Имя) — выполнить (задача) — срок. ---- diff --git a/content/questionnaire.md b/content/questionnaire.md index a5b4b32..179d90f 100644 --- a/content/questionnaire.md +++ b/content/questionnaire.md @@ -1,64 +1,47 @@ # Questionnaire — STOP_AI - **Версия:** v1.0-questionnaire -**Дата:** (заполните) +**Дата:** 19.10.2025 **Авторы:** Дулаев А., Брынцев А., Карнаухов Г., Дмитриев И. - ## Введение -Цель анкеты — понять требования заказчика к функциональности и политике конфиденциальности STOP_AI. - - ---- - - -## Вопросы (Дулаев Арсен — 6 вопросов) -1. -2. -3. -4. -5. -6. - - ---- - - -## Вопросы (Брынцев Андрей — 6 вопросов) -1. -2. -3. -4. -5. -6. - - ---- +Цель анкеты — понять требования заказчика к функциональности и +политике конфиденциальности STOP_AI. -## Вопросы (Карнаухов Глеб — 6 вопросов) -1. -2. -3. -4. -5. -6. +## Вопросы (Дулаев Арсен) +1. +2. +3. +4. +5. +6. ---- +## Вопросы (Брынцев Андрей) +1. +2. +3. +4. +5. +6. -## Вопросы (Дмитриев Иван — 6 вопросов) -1. -2. -3. -4. -5. -6. +## Вопросы (Карнаухов Глеб) ---- +1. +2. +3. +4. +5. +6. +## Вопросы (Дмитриев Иван) -## Заключение +1. +2. +3. +4. +5. +6. diff --git a/docs/approvals.md b/docs/approvals.md index f5e46ed..03df95a 100644 --- a/docs/approvals.md +++ b/docs/approvals.md @@ -1,17 +1,18 @@ # Approvals & Branch Protection - ## Политика аппрувов -- Для мержа в `main` требуется **3** approv'а. +Для мержа в `main` требуется **3** approvals. +Апруверы должны быть членами команды BDBB с ролями Write/Maintain. ## Code Owners -- Файлы в `docs/` и `content/` имеют назначенных CODEOWNERS (см. `.github/CODEOWNERS`). +Файлы в `docs/` и `content/` имеют назначенных CODEOWNERS +(см. `.github/CODEOWNERS`). При изменениях в этих папках GitHub +автоматически запросит аппрув владельцев. ## Экстренные исправления (hotfix) -- В экстренных случаях создавайте ветку `hotfix/` и помечайте PR как `hotfix`. -- Если нужно срочно влить в main и политика защиты блокирует, свяжитесь с владельцами. +В экстренных случаях создавайте ветку `hotfix/` и помечайте PR +как `hotfix`. ---- diff --git a/docs/contribution.md b/docs/contribution.md index e5d8109..92a607f 100644 --- a/docs/contribution.md +++ b/docs/contribution.md @@ -1,34 +1,33 @@ # Contribution Guide - ## Ветки -- `feature/-<описание>` — новые материалы/файлы -- `fix/-<описание>` — исправления -- `docs/` — изменения в документации -- `hotfix/-<описание>` — срочные исправления +- `feature/-<описание>` — новые материалы/файлы. +- `fix/-<описание>` — исправления. +- `docs/` — изменения в документации. +- `hotfix/-<описание>` — срочные исправления. ## Коммиты -- `feat:` — новая функциональность -- `fix:` — исправление -- `docs:` — документация -- `chore:` — вспомогательные задачи +Используйте Conventional Commits: + +- `feat:` — новая функциональность. +- `fix:` — исправление. +- `docs:` — документация. +- `chore:` — вспомогательные задачи. Примеры: + - `docs: add interview protocol template` - `feat: add questionnaire draft from Dulaev` - ## Pull Request -- Открывайте PR в `main` через веб-интерфейс или GitHub CLI -- Заполняйте шаблон PR (`.github/PULL_REQUEST_TEMPLATE.md`) -- Требуется **3** approvals (см. docs/approvals.md) -- Все проверки CI должны быть зелёными +- Открывайте PR в `main` через веб-интерфейс или GitHub CLI. +- Заполняйте шаблон PR (`.github/PULL_REQUEST_TEMPLATE.md`). +- Требуется **3** approvals (см. docs/approvals.md). +- Все проверки CI должны быть зелёными. ## Merge policy -- `Squash and merge` для чистоты истории. - ---- +Рекомендуем `Squash and merge` для чистоты истории. diff --git a/docs/process.md b/docs/process.md index cd10c78..cb9d827 100644 --- a/docs/process.md +++ b/docs/process.md @@ -1,16 +1,12 @@ # Process: from idea to release - -1. Формулировка задачи → Issue -2. Назначение исполнителя → ветка `feature/...` -3. Реализация → PR, указание ревьюверов -4. CI должен быть зелёным, нужно 3 апрува -5. Merge в `main` → тегирование релиза (пример: `v1.0-questionnaire`) -6. Деплой документации → GitHub Pages (gh-pages) - +1. Формулировка задачи → Issue. +2. Назначение исполнителя → ветка `feature/...`. +3. Реализация → PR, указание ревьюверов. +4. CI должен быть зелёным, нужно 3 апрува. +5. Merge в `main` → тегирование релиза (пример: `v1.0-questionnaire`). +6. Деплой документации → GitHub Pages (gh-pages). ## Тегирование -- Для финальной версии анкеты используйте тег `v1.0-questionnaire`. - ---- +Для финальной версии анкеты используйте тег `v1.0-questionnaire`. From cedb3ded0656e04da84d863aea2c9c70bdce54aa Mon Sep 17 00:00:00 2001 From: Arsen Date: Sun, 19 Oct 2025 16:31:08 +0300 Subject: [PATCH 2/3] chore: fix markdown style to satisfy markdownlint --- README.md | 3 +-- content/interview_protocol.md | 1 - content/questionnaire.md | 1 - docs/approvals.md | 1 - 4 files changed, 1 insertion(+), 5 deletions(-) diff --git a/README.md b/README.md index 3f460f6..3e89664 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # STOP_AI — BDBB -**Краткое описание** +# Краткое описание STOP_AI — приложение для безопасного и конфиденциального блокирования LLM-сервисов на всех платформах. Блокирует сайты и приложения, не хранит @@ -44,4 +44,3 @@ LLM-сервисов на всех платформах. Блокирует са ## Ссылка на Pages Будет автоматически опубликована после первого успешного деплоя. - diff --git a/content/interview_protocol.md b/content/interview_protocol.md index 74b2bfa..91b0aa8 100644 --- a/content/interview_protocol.md +++ b/content/interview_protocol.md @@ -15,4 +15,3 @@ - [ ] (Имя) — выполнить (задача) — срок. - [ ] (Имя) — выполнить (задача) — срок. - diff --git a/content/questionnaire.md b/content/questionnaire.md index 179d90f..13806da 100644 --- a/content/questionnaire.md +++ b/content/questionnaire.md @@ -44,4 +44,3 @@ 4. 5. 6. - diff --git a/docs/approvals.md b/docs/approvals.md index 03df95a..505d35e 100644 --- a/docs/approvals.md +++ b/docs/approvals.md @@ -15,4 +15,3 @@ В экстренных случаях создавайте ветку `hotfix/` и помечайте PR как `hotfix`. - From c54f530b1cbdb8c51069a278cb4bdf4d1894ae6c Mon Sep 17 00:00:00 2001 From: Arsen Date: Sun, 19 Oct 2025 16:33:12 +0300 Subject: [PATCH 3/3] chore: fix markdown style to satisfy markdownlint --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index 3e89664..0567b84 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,5 @@ # STOP_AI — BDBB -# Краткое описание - STOP_AI — приложение для безопасного и конфиденциального блокирования LLM-сервисов на всех платформах. Блокирует сайты и приложения, не хранит историю (только локальный счётчик промптов), поддерживает «жёсткий режим»