thevar1able/ClickHouse
1
0
Fork 0
mirror of https://github.com/ClickHouse/ClickHouse.git synced 2024-11-26 01:22:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

DOCSUP-11551: Add ru contrib info.

Browse Source
This commit is contained in:
romanzhukov 2021-07-23 11:25:46 +03:00
parent 492af9332c
commit 4fc1613577
1 changed files with 7 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/ru/development/contrib.md
View File

@ -41,13 +41,12 @@ toc_title: "Используемые сторонние библиотеки"
## Рекомендации по добавлению сторонних библиотек и поддержанию в них пользовательских изменений {#adding-third-party-libraries}
1. Весь внешний сторонний код должен находиться в папке `contrib` в отдельных поддиректориях репозитория ClickHouse. По возможности, используйте подмодули Git.
1. Весь внешний сторонний код должен находиться в отдельных поддиректориях внутри папки `contrib` репозитория ClickHouse. По возможности, используйте подмодули Git.
2. Клонируйте официальный репозиторий [Clickhouse-extras](https://github.com/ClickHouse-Extras). Используйте официальные репозитории GitHub, если они доступны.
3. Создайте новую ветку на основе той ветки, которую вы хотите интегрировать: например, `master` -> `clickhouse/master` или `release/vX.Y.Z` -> `clickhouse/release/vX.Y.Z`.
4. Все форки [Clickhouse-extras](https://github.com/ClickHouse-Extras) можно автоматически синхронизировать с upstreams. Ветки `clickhouse/...` останутся незатронутыми, поскольку практически никто не будет использовать этот шаблон именования в своих репозиториях выше по потоку.
5. Добавьте подмодули в папку `contrib` репозитория ClickHouse, на который ссылаются вышеуказанные форки/зеркала. Настройте подмодули для отслеживания изменений в соответствующих ветках `clickhouse/...`.
6. Каждый раз, когда необходимо внести пользовательские изменения в код библиотеки, следует создавать отдельную ветку, например `clickhouse/my-fix`. Затем эта ветка должна быть влита в ветку, отслеживаемую подмодулем, например, `clickhouse/master` или `clickhouse/release/vX.Y.Z`.
7. Не добавляйте код в форки [Clickhouse-extras](https://github.com/ClickHouse-Extras), если имя форка
не соответствует шаблону `clickhouse/...`.
8. Всегда добавляйте пользовательские изменения с учетом официального репозитория. После того как PR будет объединен из (ветки функций/исправлений) вашего личного форка [Clickhouse-extras](https://github.com/ClickHouse-Extras) и подмодуль будет добавлен в репозиторий ClickHouse, следующие PR из (ветки функций/исправлений) делайте на форке [Clickhouse-extras](https://github.com/ClickHouse-Extras) в официальном репозитории библиотеки.Это позволит убедиться, что: 1) публикуемый код имеет несколько вариант использования и важность; 2) другие пользователи также могут использовать его в своих целях; 3) поддержка кода доступна не только разработчикам ClickHouse.
9. Чтобы подмодуль начал использовать новый код из исходной ветки (например, `master`), сначала следует аккуратно выполнить слияние (`master` -> `clickhouse/master`) и только после этого подмодуль можно будет интегрировать в ClickHouse. Это связано с тем, что пользовательские изменения могут быть объединены в отслеживаемой ветке (например, `clickhouse/master`) и поэтому ветка может отличаться от своего первоначального аналога (`master`).
4. Все копии [Clickhouse-extras](https://github.com/ClickHouse-Extras) можно автоматически синхронизировать с вышестоящими по потоку (upstream). Ветки `clickhouse/...` останутся незатронутыми, поскольку практически никто не будет использовать этот шаблон именования в своих репозиториях выше по потоку.
5. Добавьте подмодули в папку `contrib` репозитория ClickHouse, на который ссылаются вышеуказанные копии. Настройте подмодули для отслеживания изменений в соответствующих ветках `clickhouse/...`.
6. Каждый раз, когда необходимо внести пользовательские изменения в код библиотеки, следует создавать отдельную ветку, например `clickhouse/my-fix`. Затем эта ветка должна быть объединена в ветку, отслеживаемую подмодулем, например, `clickhouse/master` или `clickhouse/release/vX.Y.Z`.
7. Не добавляйте код в репозиторий [Clickhouse-extras](https://github.com/ClickHouse-Extras), если имя не соответствует шаблону `clickhouse/...`.
8. Всегда добавляйте пользовательские изменения с учетом официального репозитория. После того как PR будет объединен из (ветки разработки/исправлений) вашего личного репозитория [Clickhouse-extras](https://github.com/ClickHouse-Extras) и подмодуль будет добавлен в репозиторий ClickHouse, следующие PR из (ветки разработки/исправлений) делайте на основе [Clickhouse-extras](https://github.com/ClickHouse-Extras) в официальном репозитории библиотеки. Это позволит убедиться, что: 1) публикуемый код имеет несколько вариант использования и важность; 2) другие пользователи также могут использовать его в своих целях; 3) поддержка кода доступна не только разработчикам ClickHouse.
9. Чтобы подмодуль начал использовать новый код из исходной ветки (например, `master`), сначала следует аккуратно выполнить слияние (`master` -> `clickhouse/master`) и только после этого подмодуль можно будет добавлен в ClickHouse. Это связано с тем, что пользовательские изменения могут быть объединены в отслеживаемой ветке (например, `clickhouse/master`) и поэтому ветка может отличаться от своего первоначального аналога (`master`).