CONTRIBUTING.md

Участие в проекте

Вначале, хотим поблагодарить Вас за желание участвовать в проекте!

Далее описаны советы, как сделать свое участие наиболее эффективным для проекта и для себя. Это не жесткие правила, поэтому используйте свой разум, если здесь что-либо не описано.

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

В проекте может участвовать любой желающий. Достаточно иметь общеполезную разработку, идею разработки или желание помочь другим в развитии имеющегося инструмента. Предлагать исправления/новую функциональность может любой, в т.ч. и не сотрудник компании. Оставить заявку на участие в проекте можно по ссылке.

Требования к проектам

Код разработки обязательно должен быть полностью открыт сообществу. Если используются дополнительные библиотеки, разработанные автором, то их исходный код также должен быть включен в состав репозитория. Строго запрещается использовать готовый код, не имея на него прав собственности. Разработка не может содержать код, заимствованный из других ПП и сервисов, за исключением случаев, когда владелец дал согласие на включение его кода в состав библиотеки. Это касается в т.ч. совместных ПП с фирмой 1С, которые разрабатывает компания 1С-РАРУС. В начале каждого модуля располагается ссылка на лицензию и авторские права компании 1С-РАРУС. В справке к основному объекту обязательно указываются авторские права и логотип компании 1С-РАРУС. При разработке необходимо строго соблюдать стандарты разработки фирмы 1С. Инструментом для разработки может быть как конфигуратор, так и EDT, но исходные коды в репозитории хранятся исключительно в формате проекта EDT. Завершение очередного цикла развития инструмента сопровождается подготовкой релизной сборки, публикуемой в репозитории в разделе релизов.

Авторские права и лицензия

Разработка ведется на условиях лицензии Attribution-ShareAlike 4.0 International (CC BY-SA 4.0). Таким образом, возможно свободное использование кем угодно на любом проекте внедрения и у любого клиента. Основное ограничение - сохранение указания авторских прав и логотипа компании 1С-РАРУС. Полный текст лицензии доступен по ссылке. Включение в состав тиражируемого программного продукта, собственником которого НЕ является компания 1С-РАРУС (например, любой совместный с фирмой 1С продукт) возможно исключительно с соблюдением следующих требований:

• сохранить ссылку на лицензию, авторские права и логотип компании 1С-РАРУС;
• проинформировать ответственных лиц 1С-РАРУС о заимствовании в составе тиражного продукта;
• указать в пользовательской документации конечного программного продукта заимствование данной библиотеки.

Лицензия

1. Добавляя любой контент в этот репозиторий (в т.ч. код), вы соглашаетесь с тем, что Ваш контент будет поставляться по лицензии проекта.
2. Создавая "Запрос на объединение" текстов модулей, вы подтверждаете, что публикуете код с согласия правообладателя (это вы или ваша компания). Внимание! Если вы работаете в компании, убедитесь, что вы не публикуете код вашей компании без ее согласия.
3. При модификации текстов модулей Вы должны добавить себя или свою компанию в секцию копирайта в заголовке модуля. Если в секции копирайта уже указан один дополнительный автор, необходимо заменить на ООО 1С-Рарус и другие.
4. При создании новых модулей, в заголовок модуля необходимо добавить лицензию этого проекта и правообладателя.

///////////////////////////////////////////////////////////////////////////////////////////////////////
// Copyright (c) 2022-2026, ООО 1С-Рарус
// Все права защищены. Эта программа и сопроводительные материалы предоставляются
// в соответствии с условиями лицензии Attribution-ShareAlike 4.0 International (CC BY-SA 4.0)
// Текст лицензии доступен по ссылке:
// https://creativecommons.org/licenses/by-sa/4.0/
///////////////////////////////////////////////////////////////////////////////////////////////////////

Сообщить об ошибке

Печально, что ошибка существует, но мы благодарны, что вы о ней нам сообщите!

Прежде чем зарегистрировать

• Проверьте раздел Issues, чтобы не создавать дубликатов

Как сообщить об ошибке эффективно

Следуйте простым правилам:

1. Задайте понятный заголовок issue, лаконично и исчерпывающе определяющий проблему
   • постарайтесь не допускать двойного смысла, сленга из других областей и т.д.
   • Не используйте "метки" в заголовке - для этого существуют сами метки (labels)
2. Опишите сценарий воспроизведения ошибки.
   • скриншоты очень сильно помогают, но не заменяют сценарий
   • добавьте логи ЖР, из лог-файлов (убедитесь, что они не содержат приватной информации)
3. Опишите, что есть ошибка по вашему мнению и почему
4. Опишите ожидаемое поведение

Исправление ошибок

• Создайте issue в проекте с описанием ошибки. Убедитесь, что владельцы проекта также считают текущее поведение ошибочным.
• Создайте ветку в своем форке с именем bugfix/issue-<Номер issue>-доп-название
• Создайте pull-request из своей ветки в ветку master проекта
• Убедитесь, что модификация кода действительно исправляет ошибку, описанную в issue, и не привносит новую функциональность - новую функциональность следует делать отдельным issue и pull-request'ом.
• Следуйте общим правилам Pull/merge request

Предложите улучшение функциональности

1. Задайте понятный заголовок issue, лаконично и исчерпывающе определяющий новую функциональность
2. Опишите суть улучшений и обсудите в issue варианты реализации.
3. Реализуйте Ваше улучшение функциональности проекта в отдельном форке и предложите его через Pull/merge request

Pull Requests (Merge Requests)

• Создайте issue в проекте с описанием новой функциональности, желательно перед началом работы, чтобы исключить параллельную работу разных людей над одной задачей
• Создайте ветку в своем форке с именем feature/issue-<Номер issue>-доп-название
• Внесите изменения
• Создайте pull-request из своей ветки в ветку master проекта
• Укажите ссылку на issue, которую закрывает данный pull-request
• Установите в своем PR флажок "allow edits from maintainers"