Для разработчиков

Спасибо, что хотите внести вклад в этот проект!

Оглавление

1. Структура проекта
2. Добавление нового модуля
3. Политика управления историей
4. Кодстайл
5. Лицензия

Структура проекта

core

• Language: Go
• Shared core libraries

adapters

• Language: Go
• Broker adapters implementing core/broker interfaces
• Current modules: adapters/bcs, adapters/tinvest

botkit

• Language: Go
• Public runtime/SDK for building bots outside this monorepo

bots

• Language: Go
• First-party trading bots maintained in this monorepo

dashboard/backend

• Language: Go

dashboard/frontend

• Language: TypeScript
• Package Manager: pnpm
• Frameworks: Svelte, SvelteKit

Добавление нового модуля

• Добавьте ваш модуль в раздел "Структура проекта" файла CONTRIBUTING.md с указанием используемого стека.
• Если модуль на Go — создайте go.mod и добавьте путь к модулю в go.work.
• Настройте интеграцию с CI: добавьте модуль в существующий workflow либо создайте новый workflow с этапами проверки линта, кодстайла, сборки и тестирования. Добавьте модуль в Dependabot для автоматического отслеживания и обновления зависимостей через pull request.

Политика управления историей

• Запрещены merge-коммиты — используйте только rebase- или squash-merge при объединении изменений.
• Запрещён прямой push в ветку main — все изменения должны проходить через Pull Request.
• Запрещено принимать в ветку main файлы без лицензионного заголовка — шаблон заголовка.
• Для сообщений коммитов используйте стандарт Conventional Commits.
• Для названий Pull Request используйте стандарт Conventional Commits.
• Для именования веток используйте шаблон type/<название>-<номер_issues>
  • type — категория изменений: feature, fix, chore, ci, docs, question
  • <название> — название issue или краткое описание задачи (используйте "-" вместо пробелов)
  • <номер_issues> — номер соответствующего issue (при наличии)

Кодстайл

Общие

• Все комментарии в коде должны быть написаны только на английском языке.
• Каждый исходный файл должен начинаться с лицензионного заголовка (см. шаблон).

Go

Принят стандартный стиль Google.

Дополнительные ресурсы:

• Effective Go
• Code Review Comments
• Test Comments

TypeScript

Eslint обнаружит большинство проблем со стилем, которые могут быть в вашем коде. Вы можете проверить состояние стиля кода, просто запустив команду pnpm lint.

Лицензия

Проект распространяется по лицензии GNU Affero General Public License v3.0 (см. файл LICENSE).

Шаблон лицензионного заголовка

Правила:

• Каждый исходный файл должен начинаться с лицензионного заголовка.
• Нужно указывать имя, фамилию или псевдоним.
• Если заголовок уже существует, вы можете добавить себя в Copyright (C) через запятую.
• Указывается год первого появления файла (или диапазон, если файл поддерживается долго).

Copyright (C) 2026 <name or nickname>
Licensed under the GNU Affero General Public License v3.0 or later.
See the LICENSE file in the project root for the full license text.