Вклад

Внося вклад в этот репозиторий, пожалуйста, сначала обсудите изменения, которые вы хотите внести, через issue, электронную почту или любой другой способ с владельцами этого репозитория перед внесением изменений.

Обратите внимание, что у нас есть кодекс поведения, пожалуйста, следуйте ему во всех ваших взаимодействиях с проектом.

Контрольный список для запроса на включение изменений (pull request)

Прежде чем отправлять свои запросы на включение изменений, убедитесь, что вы следуете этому списку:

• Прочитайте руководство по внесению вклада.
• Прочитайте Кодекс поведения.
• Следуйте инструкциям руководства по разработке
• Убедитесь, что вы подписали Сертификат происхождения разработчика (DCO).
• Проверьте, соответствуют ли мои изменения рекомендациям.
• Изменения соответствуют PEP.8 Python Coding Style.
• Запустите модульные тесты и напишите примеры.

Вклад в FATE

Сертификат происхождения разработчика

Мы более чем рады принять ваши патчи. Для начала, пожалуйста, убедитесь, что вы подписываете каждый коммит Сертификатом происхождения разработчика (DCO). Если вы всё ещё не знакомы с DCO, пожалуйста, посетите этот веб-сайт для получения дополнительной информации.

Внесение кода

1. Если вы хотите предложить новую функцию и реализовать её, пожалуйста, откройте issue и обсудите дизайн и реализацию с нами.
2. Если вас интересует реализация существующей функции или исправление ошибки, пожалуйста, оставьте комментарий к задаче, над которой вы хотите работать. И всё же настоятельно рекомендуется обсудить с нами ваш дизайн и реализацию.
3. Если вы не знаете, с чего начать, попытка решить более мелкие и простые задачи может быть хорошей идеей, а затем взгляните на задачи с меткой «вклад приветствуется».

Как только вы будете готовы отправить свой запрос на включение изменений, мы создадим ветку участника, в которую вы сможете отправить запрос. Затем члены команды FATE будут назначены для проверки и тестирования вашего запроса. Как только проверка будет пройдена, ваш вклад будет принят и будет выпущен в будущей версии.

Если у вас есть идеи новых функций, но вы не знаете, как начать, было предоставлено руководство по разработке.

Вклад

Рекомендации и стандарты для внесения вклада

Перед отправкой запроса на включение изменений следуйте некоторым принципам и стандартам:

• Включайте модульные тесты при внесении новых функций. Вы можете создать тестовую папку в своём модуле и поместить в неё тестовые файлы. Вот пример. FATE предоставляет скрипт теста, чтобы вы могли проверить все модульные тесты. Убедитесь, что ваш код работает правильно.
• Предоставьте примеры в папке примеров. Если требуются данные определённого формата, также предоставьте пример данных в папку данных. В примерах алгоритмов должны быть предоставлены некоторые файлы dsl и conf, а также файл testsuite, с помощью которого пользователь может легко протестировать ваш пример. Вот пример файла testsuite.
• После того как вы внесли новую функцию в FATE, члены команды FATE (по умолчанию) отвечают за обслуживание этой функции. Это означает, что мы должны сравнить выгоду от вклада с затратами на поддержание функции и принять те функции, которые имеют большую выгоду.

Лицензия

Включите лицензию в начало новых файлов. Пример лицензии приведён ниже.

#
#  Copyright 2019 The FATE Authors. All Rights Reserved.
#
#  Licensed under the Apache License, Version 2.0 (the "License");
#  you may not use this file except in compliance with the License.
#  You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
#  Unless required by applicable law or agreed to in writing, software
#  distributed under the License is distributed on an "AS IS" BASIS,
#  WITHOUT
``` ### Гарантии и условия любого рода, явные или подразумеваемые.

# См. лицензию для получения информации о конкретных разрешениях и ограничениях в рамках лицензии.
#

Стиль кода

Необходимо убедиться, что ваш код и комментарии соответствуют следующему стилю кодирования.

• PEP.8 Python Coding Style.

• Numpy Docstring Format

Процесс запроса на включение изменений (Pull Request)

1. При выполнении сборки убедитесь, что все зависимости установки или сборки удалены до конца слоя.
2. Обновите файл README.md с информацией об изменениях интерфейса, включая новые переменные среды, открытые порты, полезные расположения файлов и параметры контейнера.
3. Увеличьте номера версий в любых файлах примеров и файле README.md до новой версии, которую будет представлять этот запрос на включение изменений. Мы используем схему управления версиями SemVer.
4. Вы можете объединить запрос на включение изменений после того, как получите одобрение двух других разработчиков, или, если у вас нет разрешения на это, вы можете попросить второго рецензента объединить его за вас.