1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2026-06-20 09:19:27 +02:00

Доработка CONTIBUTING.md

This commit is contained in:
Anton Titovets
2025-12-31 12:56:10 +03:00
parent dcae94a9b5
commit fc747690de
+5 -3
View File
@@ -4,12 +4,12 @@
## 🧐 Основное
Сразу стоит отметить, что OpenIntegrations имеет явный перекос в сторону авторского проекта, нежели правильного настоящего open-source, где участие максимально широкого круга людей является целью, приветствуется и строго регламентировано. На практике это, в первую очередь, означает ограничение круга задач, которые могут быть делегированы сообществу:
Сразу стоит отметить, что OpenIntegrations имеет явный перекос в сторону авторского проекта, нежели правильного настоящего open-source, где участие максимально широкого круга людей является целью, приветствуется и строго регламентировано. На практике это, в первую очередь, означает ограничение круга задач, которые могут быть взяты вами за основу своего вклада в данный репозиторий:
<br>
🟢 **Исправление ошибок и доработка существующих модулей** <br>
Если вы нашли ошибку в существующем функционале и хотите ее исправить - это всегда приветствуется. Способ исправления (и уточнение, что это действительно ошибка), конечно, лучше все равно обсудить, но, так или иначе, это тот вид участия, который максимально прост и обычно не требует лишнего погружения во все тонкости проекта
Если вы нашли ошибку в существующем функционале и хотите ее исправить - это всегда приветствуется. Способ исправления (и уточнение, что это действительно ошибка), конечно, лучше все равно обсудить в Issues, но, так или иначе, это тот вид участия, который максимально прост и обычно не требует лишнего погружения во все тонкости проекта
🟡 **Добавление новых функций в существующие модули** <br/>
Это куда более сложный, но допустимый способ участия. Техническая сторона его реализации будет описана в следующем разделе. Тут важно отметить только то, что добавление нового функционала обязательно влечет за собой дискуссию о его целесообразности и поддерживаемости. Не спешите реализовывать и делать PR - сделайте сначала Issues
@@ -21,13 +21,15 @@
> Также, вне зависимости от желаемого вида участия, я был бы очень благодарен, если бы это участие началось не с PR, а с Issues: отказ участнику - это всегда неприятно, но он неизбежно последует, если предлагаемые изменения не к месту (по моему эгоистичному мнению) или выполнены некорректно с технической части. Велик шанс, что вы просто потратите свое время в пустую
<br>
## 🤖 Техническая часть
В отличии от сути вносимых изменений, где каждый случай уникален и требует обсуждения, техническая их реализация достаточно сильно регламентирована и практически не терпит отхода в сторону от генеральной линии. Обусловлено это автоматизацией различных процессов, будь то создание документации, тестирование, перевод на английский язык или подготовка релизов. Эти процессы просто не работают для функций и модулей, реализованных без учета установленных стандартов
Разработка проекта ведется в ветке `main`, исключительно в русской версии пакета для 1С:Предприятие формата [EDT](https://openintegrations.dev/docs/Start/Build-from-source). Исходный код данной версии находится в `src/ru/OPI`. Никакие друге части исходного кода не подлежат изменению: версия для OneScript, CLI, а также все варианты английской ветки проекта, являются продуктом автоматического преобразования из оригинала и теряют все ручные изменения при очередном цикле CI
Если доработка является исправлением ошибки, то никаких других условий к ней не применяется. Добавление же новых функций сопряжено еще с рядом дополнительных регламентов. Так, любую добавляемую функцию в Открытом пакете интеграций условно можно разделить на 4 обязательные части:
Если ваша доработка является исправлением ошибки, то никаких других особенных условий к ней не применяется. Добавление же новых функций, в свою очередь, сопряжено еще с рядом дополнительных регламентов, которые должны быть соблюдены. В частности, любую добавляемую функцию в Открытом пакете интеграций условно можно разделить на 4 части, каждая из которых должна присутствовать в вашей реализации:
### Тело функции