Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
## Изменение
## Change

<!-- Кратко: проблема, итоговое поведение и связанные issue. -->
<!-- Describe the problem, resulting behavior, and related issues. -->

## Проверка
## Validation

<!-- Укажите выполненные команды и результаты; отдельно — то, что не проверялось. -->
<!-- List checks and results. State anything not verified separately. -->

## Данные, доступ и документация
## Data, access, and documentation

<!-- Отметьте влияние на миграции, данные пользователей, права/секреты и публичные контракты. Ссылки на обновлённые руководства. Для UI используйте только вымышленные данные. -->
<!-- Note migration, user-data, permission/secret, and public-contract impact.
Link updated guides. Use fictional data in UI evidence. -->
8 changes: 8 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ dist/
.turbo/
*.tsbuildinfo
.vitepress/
!docs/.vitepress/
docs/.vitepress/*
!docs/.vitepress/config.mts
!docs/.vitepress/navigation.ts
apps/ui/src/generated/plugin-ui.ts
apps/ui/src/generated/plugin-ui.css

Expand Down Expand Up @@ -64,6 +68,10 @@ docs/public/api/LICENSE
docs/public/api/NOTICE
docs/reference/sdk/
docs/reference/kit/
docs/ru/reference/sdk/
docs/ru/reference/kit/
docs/public/brand/
docs/public/assets/brand/

# Machine-specific editor and OS files; retain shared editor settings
/.vscode/*
Expand Down
6 changes: 6 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,12 @@ docs/reference/routes.md
docs/reference/*-guide.md
docs/reference/kit-*.md
docs/reference/plugin-color.md
docs/ru/reference/sdk
docs/ru/reference/kit
docs/ru/reference/routes.md
docs/ru/reference/*-guide.md
docs/ru/reference/kit-*.md
docs/ru/reference/plugin-color.md
docs/archive.md
/infra/
/plugins/
Expand Down
45 changes: 17 additions & 28 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,32 @@
# Участие в проекте
# Contributing

Ошибки и предложения принимаются в [GitHub Issues](https://github.com/Asmblyr/Collaborative/issues).
Для изменения кода создайте ветку и pull request. Крупные изменения архитектуры,
модели данных или публичных контрактов сначала обсудите в issue.
<!-- languages -->

## Подготовка
[English](CONTRIBUTING.md) · [Русский](CONTRIBUTING.ru.md)

Следуйте [руководству первого запуска](docs/guide/getting-started.md).
Для карты компонентов и команд используйте [локальную разработку](docs/development/local-development.md),
для нового плагина — [первое расширение](docs/development/first-extension.md).
Публичные пакеты SDK и Kit пока используются как workspace-пакеты репозитория.
Описание компонентов — в [архитектуре](docs/development/architecture.md).
<!-- /languages -->

Не включайте в изменения `.env`, ключи, пользовательские данные, дампы,
локальные скриншоты, внутренние планы или сгенерированные сборки.
Используйте вымышленные данные и домены `example.test` в примерах.
Report bugs and proposals in [GitHub Issues](https://github.com/Asmblyr/Collaborative/issues). Create a branch and pull request for code changes. Discuss substantial architecture, data-model, or public-contract changes in an issue first.

## Проверки
## Setup

Follow [first-time setup](docs/guide/getting-started.md), [local development](docs/development/local-development.md), and [your first plugin](docs/development/first-extension.md). Repository development uses workspace packages; published SDK/CLI previews use the beta tag. See [architecture](docs/development/architecture.md).

Never commit environment files, keys, user data, dumps, local screenshots, internal plans, or generated builds. Use fictional data and example.test domains.

## Checks

```sh
pnpm check
pnpm build
```

Интеграционные тесты запускаются через `scripts/test.mjs`: он создаёт и удаляет
отдельную PostgreSQL-базу. Для `TEST_DATABASE_ADMIN_URL` нужен локальный сервер
и роль с правом `CREATEDB`. Не запускайте тестовые файлы напрямую на рабочей базе.
Дополнительный live-тест LavinMQ требует отдельно настроенного примера.
Integration tests run through scripts/test.mjs, which creates/removes a disposable PostgreSQL database. TEST_DATABASE_ADMIN_URL needs a local server and CREATEDB role. Never run test files directly against a working database. The optional live LavinMQ test needs a separately configured broker.

Форматируйте изменённые файлы Prettier. При изменении поведения обновляйте
соответствующее руководство; при изменении HTTP или SDK/Kit — также контракты
и генерируемые справочники. Подробнее — [документация](docs/development/documentation.md).
Format changed files with Prettier. Update feature guides with behavior changes; update HTTP/SDK/Kit contracts and generated references with API changes. See [documentation workflow](docs/development/documentation.md).

## Pull request
## Pull requests

Опишите проблему, итоговое поведение и выполненные проверки. Для изменений UI
проверьте обычный и ограниченный доступ и приложите результат на вымышленных данных.
Существующие миграции не переписывайте: добавляйте новую миграцию и учитывайте
сохранность данных. Не смешивайте исправление с несвязанными переработками.
Describe the problem, resulting behavior, and checks. Verify UI with ordinary and restricted access using fictional data. Add new migrations rather than rewriting old ones; preserve existing data. Avoid unrelated refactors.

Инструкции для кодовых агентов начинаются с [AGENTS.md](AGENTS.md).
Вклад распространяется на условиях [MIT](LICENSE).
Coding-agent instructions start at [AGENTS.md](AGENTS.md). Contributions use the [MIT license](LICENSE).
49 changes: 49 additions & 0 deletions CONTRIBUTING.ru.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Участие в проекте

<!-- languages -->

[English](CONTRIBUTING.md) · [Русский](CONTRIBUTING.ru.md)

<!-- /languages -->

Ошибки и предложения принимаются в [GitHub Issues](https://github.com/Asmblyr/Collaborative/issues).
Для изменения кода создайте ветку и pull request. Крупные изменения архитектуры,
модели данных или публичных контрактов сначала обсудите в issue.

## Подготовка

Следуйте [руководству первого запуска](docs/ru/guide/getting-started.md).
Для карты компонентов и команд используйте [локальную разработку](docs/ru/development/local-development.md),
для нового плагина — [первое расширение](docs/ru/development/first-extension.md).
SDK, Kit и CLI доступны под npm-тегом `beta`; внутри репозитория используются workspace-пакеты.
Описание компонентов — в [архитектуре](docs/ru/development/architecture.md).

Не включайте в изменения `.env`, ключи, пользовательские данные, дампы,
локальные скриншоты, внутренние планы или сгенерированные сборки.
Используйте вымышленные данные и домены `example.test` в примерах.

## Проверки

```sh
pnpm check
pnpm build
```

Интеграционные тесты запускаются через `scripts/test.mjs`: он создаёт и удаляет
отдельную PostgreSQL-базу. Для `TEST_DATABASE_ADMIN_URL` нужен локальный сервер
и роль с правом `CREATEDB`. Не запускайте тестовые файлы напрямую на рабочей базе.
Дополнительный live-тест LavinMQ требует отдельно настроенного примера.

Форматируйте изменённые файлы Prettier. При изменении поведения обновляйте
соответствующее руководство; при изменении HTTP или SDK/Kit — также контракты
и генерируемые справочники. Подробнее — [документация](docs/ru/development/documentation.md).

## Pull request

Опишите проблему, итоговое поведение и выполненные проверки. Для изменений UI
проверьте обычный и ограниченный доступ и приложите результат на вымышленных данных.
Существующие миграции не переписывайте: добавляйте новую миграцию и учитывайте
сохранность данных. Не смешивайте исправление с несвязанными переработками.

Инструкции для кодовых агентов начинаются с [AGENTS.md](AGENTS.md).
Вклад распространяется на условиях [MIT](LICENSE).
Loading