Если вы хотите внести улучшение или исправить существующую ошибку, мы рекомендуем вам сначала открыть новую задачу в Jira, прежде чем создавать запрос на вытягивание (pull request).
Важно отметить, что при открытии задачи вы должны сначала выполнить быстрый поиск существующих задач, чтобы убедиться, что ваше предложение уже не добавлено в качестве задачи. Если вашей задачи ещё нет, и вы готовы её создать, обязательно укажите, что вы хотели бы реализовать, улучшить или исправить.
Затем команда Rasa свяжется с вами, чтобы обсудить, соответствует ли предложенная функция дорожной карте компании, и мы поможем вам сформировать предложенную функцию таким образом, чтобы её можно было объединить с кодовой базой Rasa.
Если вы хотите предоставить код, но не знаете, над чем работать, ознакомьтесь с доской Jira, чтобы найти существующие открытые задачи.
Задачи подбираются командой Rasa так, чтобы они имели метки, соответствующие сложности/ожидаемому времени, необходимому для решения проблемы.
Чтобы поработать над существующей задачей, перейдите на доску проектов для участников, добавьте комментарий о том, что вы хотите над ней поработать, и включите любые решения, которые у вас уже есть.
Кто-то из команды Rasa затем назначит эту задачу вам и поможет вам в процессе работы.
Вот как команда GitHub определяет PR:
«Запросы на вытягивание позволяют вам сообщать другим об изменениях, которые вы внесли в ветку репозитория на GitHub. После открытия запроса на вытягивание вы можете обсудить и просмотреть потенциальные изменения с соавторами и добавить последующие коммиты, прежде чем ваши изменения будут объединены в основную ветку».
Этот процесс используется как членами команды Rasa, так и участниками Rasa для внесения изменений и улучшений в открытый исходный код Rasa.
Мы обычно рекомендуем... Открытие задачи на Jira перед запросом на включение (pull request), если такой задачи ещё нет. Это помогает организовать обсуждение перед принятием решения о реализации.
Если вы хотите быстро получить обратную связь от команды Rasa, вы можете создать черновик запроса на включение.
Если ваш запрос на включение превышает 500 строк, пожалуйста, рассмотрите возможность разделить его на несколько более мелких вкладов.
Чтобы обеспечить стандартизированный стиль кода, мы просим вас следовать нашим рекомендациям по стилю кода.
Если вы хотите автоматически форматировать свой код при каждом коммите, вы можете использовать pre-commit. Просто установите его через pip install pre-commit
и выполните pre-commit install
в корневой папке. Это добавит хук в репозиторий, который будет переформатировать файлы при каждом коммите.
Если вы хотите вручную форматировать код, установите black
с помощью poetry install
. Чтобы переформатировать файлы, выполните make formatter
.
Если вы хотите проверить типы вручную, установите mypy
с помощью poetry install
. Для проверки типов выполните make types
.
Тесты CI/CD, которые мы запускаем, можно найти в файле continuous-integration.yml.
Перейдите в репозиторий Rasa и нажмите «Форк». Создание форка проекта позволяет вам создать копию проекта, которую вы можете редактировать и использовать для предложения изменений в исходный проект.
После форка копия репозитория Rasa появится в вашем списке репозиториев GitHub.
Для внесения изменений в вашу копию репозитория Rasa клонируйте репозиторий на вашем локальном компьютере. Для этого выполните следующую команду в терминале:
git clone https://github.com/your_github_username/rasa.git
Ссылку на репозиторий можно найти после нажатия кнопки «Клонировать» или «Скачать», как показано на изображении ниже:
Обратите внимание: предполагается, что у вас установлен git на локальном компьютере. Если нет, ознакомьтесь со следующим руководством, чтобы узнать, как его установить.
Прежде чем вносить какие-либо изменения в клонированный репозиторий, убедитесь, что у вас есть последняя версия исходного репозитория Rasa. Для этого выполните следующие команды в терминале:
cd rasa
git remote add upstream git://github.com/RasaHQ/rasa.git
git pull upstream main
Это обновит локальную копию репозитория Rasa до последней версии.
На этом этапе вы можете вносить изменения в файлы в локальном каталоге вашего проекта.
В качестве альтернативы вы можете создать новую ветку, которая будет содержать реализацию вашего вклада. Для этого запустите:
git checkout -b name-of-your-new-branch
Как только вы будете довольны изменениями, внесёнными в локальные файлы, отправьте их в форкнутый репозиторий на GitHub. Для этого выполните следующие команды:
git add .
git commit -m ‘fixed a bug’
git push origin name-of-your-new-branch
Это создаст новую ветку в вашем форкнутом репозитории Rasa, и теперь вы готовы создать запрос на включение с предложенными изменениями!
Перейдите к форкнутому репозиторию и нажмите кнопку «Сравнить и запросить включение».
Откроется окно, где вы сможете выбрать репозиторий и ветку, в которую вы хотели бы предложить свои изменения, а также конкретные детали вашего вклада. В верхнем меню панели выберите следующие детали:
Базовый репозиторий: РасаHQ/раса
Базовая ветка: main.
Репозиторий главы: your-github-username/rasa.
Ветка главы: name-of-your-new-branch.
Далее обязательно обновите карточку запроса на включение изменений (pull request) с максимально возможным количеством деталей о вашем вкладе. Раздел «Предлагаемые изменения» должен содержать детали того, что было исправлено или реализовано, а статус должен отражать состояние ваших вкладов. Любое разумное изменение (не как опечатка) должно включать запись в журнале изменений, исправление ошибки должно иметь тест, новая функция должна иметь документацию и т. д.
Если вы готовы получить отзыв о своём вкладе от команды Rasa, отметьте поля «Подготовил запрос на включение изменений для проверки кода» и «Разрешить редактирование от сопровождающих».
Как только вы будете довольны всем, нажмите кнопку «Создать запрос на включение изменений». Это создаст запрос на включение ваших предложенных изменений.
Чтобы объединить ваши вклады в кодовую базу Rasa, вам нужно будет подписать лицензионное соглашение участника (CLA).
Нам необходимо знать, что вы согласны на то, чтобы ваш код был включён в кодовую базу Rasa и позволил нам использовать его в наших будущих выпусках. Вы можете найти подробное лицензионное соглашение участников Rasa здесь.
После того как вы подпишете CLA, член команды Rasa свяжется с вами, чтобы дать отзыв о вашем вкладе. В некоторых случаях вклады принимаются сразу, но часто вас могут попросить внести некоторые изменения или улучшения. Не беспокойтесь, если вас попросят что-то изменить — это совершенно нормальная часть разработки программного обеспечения.
Если вас попросили внести изменения в ваш вклад, вернитесь к локальной копии вашего репозитория на вашем компьютере, внесите изменения и отправьте их в свою ветку вклада, повторив инструкции из шага 5. Ваш запрос на включение автоматически обновится с изменениями, которые вы отправили. Как только вы внедрите все предложенные изменения, отметьте человека, который впервые рассмотрел ваш вклад, упомянув его в комментариях к вашему PR, чтобы попросить его взглянуть ещё раз. Наконец, если ваш вклад будет принят, участник команды Rasa объединит его с кодовой базой Rasa.
Вклад в открытый исходный код может занять много времени и усилий, поэтому вы должны гордиться отличной работой, которую вы проделали! Сообщите миру, что вы стали участником проекта с открытым исходным кодом Rasa, разместив информацию об этом в своих социальных сетях (обязательно отметьте @RasaHQ), упомяните свой вклад в своём резюме и приготовьтесь получить действительно крутой мерч участника Rasa!
Внесение вклада не начинается и не заканчивается кодом. Вы можете поддержать проект, планируя общественные мероприятия, создавая учебные пособия, помогая другим членам сообщества находить ответы на свои вопросы или переводя документацию и новости. Каждый вклад имеет значение! Вы можете узнать больше на нашем веб-сайте.
Вы можете оставить комментарий после Вход в систему
Неприемлемый контент может быть отображен здесь и не будет показан на странице. Вы можете проверить и изменить его с помощью соответствующей функции редактирования.
Если вы подтверждаете, что содержание не содержит непристойной лексики/перенаправления на рекламу/насилия/вульгарной порнографии/нарушений/пиратства/ложного/незначительного или незаконного контента, связанного с национальными законами и предписаниями, вы можете нажать «Отправить» для подачи апелляции, и мы обработаем ее как можно скорее.
Опубликовать ( 0 )