Слияние кода завершено, страница обновится автоматически
Хотите внести свой вклад в OpenTTD? Вот как вы можете помочь.
Пожалуйста, уделите время изучению этого документа, чтобы сделать процесс внесения вклада простым и эффективным для всех участников.
Следование этим рекомендациям помогает показать, что вы уважаете время разработчиков, управляющих и развивающих этот проект с открытым исходным кодом. В свою очередь, они должны отвечать взаимностью, решая вашу проблему или оценивая исправления и функции.
Система отслеживания проблем является предпочтительным каналом для [отчётов об ошибках](#отчёты об ошибках), но, пожалуйста, соблюдайте следующие ограничения:
Пожалуйста, не используйте систему отслеживания проблем для помощи в игре или использовании OpenTTD. Попробуйте irc, Discord или форумы.
Пожалуйста, не отвлекайте обсуждение или тролльте проблемы. Поддерживайте обсуждение по теме и уважайте мнения других.
Пожалуйста, не публикуйте комментарии, состоящие исключительно из «+1» или «
». Используйте функцию «реакции» GitHub вместо этого. Мы оставляем за собой право удалять комментарии, нарушающие это правило.
Пожалуйста, не открывайте проблемы или запросы на вытягивание (pull requests) относительно контента дополнений в NewGRF, GameScripts, AIs и т. д. Они создаются третьими сторонами. Обсудите их на irc, Discord или на форумах.
Используйте веб-переводчик, чтобы отправлять исправления и улучшения переводов игры.
Ошибка — это очевидная проблема, вызванная кодом в репозитории. Хорошие отчёты об ошибках очень полезны, так что спасибо!
Рекомендации для отчётов об ошибках:
Пожалуйста, не сообщайте о проблемах с играми, в которых вы изменили NewGRFs во время игры. (Это можно проверить с помощью консольной команды gamelog в игре.)
Пожалуйста, не сообщайте о проблемах с модифицированными версиями OpenTTD (патчпаки, неофициальные порты и тому подобное).
Используйте поиск по проблемам GitHub — проверьте, не была ли проблема уже зарегистрирована.
Проверьте, была ли проблема исправлена — попробуйте воспроизвести её, используя последнюю nightly сборку OpenTTD, доступную по адресу https://www.openttd.org.
Изолируйте проблему — в идеале создайте воспроизводимые шаги с прикреплённым сейвом (сохранённой игрой) и скриншотами. Постарайтесь использовать как можно меньше или вообще не использовать NewGRFs, AI и т. п., если это возможно.
Хороший отчёт об ошибке не должен оставлять других людей нуждающимися в дополнительной информации от вас. Пожалуйста, постарайтесь быть как можно более подробными в своём отчёте.
Все эти детали помогут людям исправить любые потенциальные ошибки. Пример:
Короткий и описательный пример названия отчёта об ошибке
Краткое изложение проблемы и среды ОС, в которой она возникает. Если подходит, включите шаги, необходимые для воспроизведения ошибки.
- Это первый шаг
- Это второй шаг
- Дальнейшие шаги и т.д.
Приложенный сейв Прикреплённые скриншоты, показывающие проблему Crashlogs, если ошибка вызывает сбой
Любая другая информация, которую вы хотите предоставить, которая имеет отношение к сообщаемой проблеме. Сюда могут входить строки кода, которые вы определили как вызывающие ошибку, и возможные решения (и ваше мнение об их достоинствах).
Прежде чем открывать запрос на добавление функции, пожалуйста, найдите время, чтобы узнать, соответствует ли ваша идея области применения и целям проекта.
Именно вы должны убедительно доказать разработчикам проекта преимущества этой функции.
Пожалуйста, предоставьте как можно больше деталей и контекста. Это означает, что не просите решение, а опишите проблему, которую вы видите, и как/почему вы думаете, что её нужно исправить. Вот перевод текста на русский язык:
С идеями вроде «отличная идея» или «на самом деле это не баг, но, возможно, стоит исправить» получается обратный эффект: на них больше никто не смотрит.
Хотя мы очень ценим обратную связь и идеи, мы закрываем запросы на добавление функций, которые не ожидаем реализовать в следующем году.
Многие из этих идей и т. д. имеют место на форумах (https://www.tt-forums.net), и если они понравятся достаточному количеству людей, кто-то встанет и сделает это.
Обычно лучше обсудить всё в Discord (https://discord.gg/openttd), прежде чем открывать запрос на добавление функции или работать над большой функцией в форке. Обсуждение может занять время, но оно может быть продуктивным и позволит избежать разочарования. :)
Хорошие запросы на включение изменений — патчи, улучшения, новые функции — фантастическая помощь.
Запросы на включение изменений должны соответствовать целям проекта (см. CONTRIBUTING.md#project-goals).
Пожалуйста, сначала спросите, прежде чем приступать к любому значительному запросу на включение изменений (например, реализация функций, рефакторинг кода, перенос на другой язык), иначе вы рискуете потратить много времени на работу над тем, что разработчики проекта могут не захотеть включить в проект.
Каждый запрос на включение изменений должен иметь чёткую область действия, без несвязанных коммитов.
Код должен соответствовать стилю (см. CODINGSTYLE.md), чтобы запросы на включение были приняты; это также включает формат сообщений коммита (см. CODINGSTYLE.md#commit-message).
Следование следующему процессу — лучший способ включить вашу работу в проект:
git clone https://github.com/<your-username>/OpenTTD.git openttd
git clone https://github.com/OpenTTD/OpenTTD-git-hooks.git openttd_hooks
cd openttd
git remote add upstream https://github.com/OpenTTD/OpenTTD.git
cd .git/hooks
ln -s ../../../openttd_hooks/hooks/* .
git fetch upstream
git checkout upstream/master -b <topic-branch-name>
git fetch upstream
git rebase upstream/master
git push --set-upstream origin <topic-branch-name>
И в любое время после этого:
git push
ВАЖНО: отправляя запрос на включение или патч, вы соглашаетесь с Лицензией (см. #license) и Уведомлением о конфиденциальности (CONTRIBUTING.md#privacy-notice).
Инструменты непрерывной интеграции (CI) отслеживают запросы на включение и помогают нам выявлять проблемы со сборкой и качеством кода.
Результаты тестов CI будут отображаться в вашем запросе на включение.
Нажав на «Подробности», вы можете увеличить масштаб; в случае сбоя он покажет вам, почему это произошло. В случае успеха он сообщит, насколько вы были круты. Совет: формат сообщения коммита (см. CODINGSTYLE.md#commit-message) является распространённой причиной сбоя проверки запросов на включение.
Нет единого источника документации по разработке OpenTTD. Это сложный проект с долгой историей и множеством API.
Хорошей отправной точкой является раздел «Разработка» на вики OpenTTD (https://wiki.openttd.org/en/Development/), который содержит ссылки на документацию вики и другие источники.
Репозиторий GitHub также включает некоторую неполную документацию в /docs (./docs). Они включают:
Основные цели официальной ветви:
В отличие от этого, расширение или изменение игрового процесса базовой игры не рекомендуется.
Причина этих целей в том, что у людей разные мнения о том, чем является OpenTTD и чем он должен быть. Когда дело доходит до игрового процесса, есть как минимум следующие группы людей:
Что касается функций игрового процесса, то есть как минимум такие группы интересов:
Чтобы угодить всем, официальная ветвь старается придерживаться оригинального игрового процесса; в конце концов, именно это всех сюда привело. Предпочтительный метод изменения и расширения игрового процесса — через дополнения, такие как NewGRF и GameScripts.
Долгое время официальная ветка также была открыта для функций, которые можно было включить/отключить, но угловые случаи, связанные с некоторыми конфигурациями, сделали некоторые части кода очень сложными. Сегодня новые функции должны работать со всеми уже существующими функциями, что не только сложно в угловых случаях, но и требует гораздо больше работы, чем просто «заставить это работать в режиме игры, в который я играю».
Предпочтительным методом внедрения новых функций игрового процесса является расширение API контента, поддержка всё большего количества дополнительного контента / модов.
Это переносит решение конфликтов от кодовой базы к авторам контента / игрокам. Более приемлемо, когда дополнения не работают вместе, чем базовая игра не работает с определёнными комбинациями настроек.
Как правило, игра должна позволять всё, что не нарушает основных правил, но она должна предупреждать игроков, если они предпринимают потенциально опасные или «глупые» действия.
Например, игрокам не запрещается запускать транспортные средства без приказов, но они получат предупреждение о транспортных средствах, имеющих слишком мало приказов. Отсутствие ограничений привело к тому, что игроки бросают себе вызов создавать сети, где все транспортные средства не имеют приказов, увеличивая возможности игрового процесса.
Форк! Существует богатая история экспериментальных патчей для OpenTTD.
Многие из них никогда не будут приняты за ядро, но представляют собой творческие и интересные способы модификации OpenTTD.
Иногда патчи объединяются в долгосрочные патчепаки, модифицированные версии OpenTTD, которые может скачать любой желающий, или модифицированные клиенты OpenTTD для специализированных многопользовательских серверов.
Одна из причин поддерживать ядро относительно... Стабильность призвана по возможности облегчить жизнь авторам патчей и сопровождающим набор патчей.
Обсуждения наборов патчей и связанные с ними темы можно найти на сайтах сообщества, таких как раздел разработки TT-Forums.
Предоставляя свой код, вы соглашаетесь лицензировать свой вклад в соответствии с GPL v2.
Мы хотели бы сообщить вам, что при внесении вклада в OpenTTD через git навсегда сохраняются имя и адрес электронной почты, которые вы предоставляете, а также фактические изменения, время и дата, когда вы их внесли, в истории версий git.
Это неизбежно, поскольку является основной функцией git. Если вы беспокоитесь о своей конфиденциальности, мы настоятельно рекомендуем использовать «Anonymous <anonymous@openttd.org>» в качестве автора коммита git. Мы можем отклонить анонимные вклады, если есть подозрение в злонамеренных намерениях.
Обратите внимание, что личность участника, однажды предоставленная, используется для проверки авторских прав и предоставления доказательств в случае внесения вредоносного коммита. Таким образом, право ЕС GDPR «забыть о себе» не применяется, так как это является законным интересом, имеющим преимущественную силу.
Также обратите внимание, что ваш коммит является публичным и, таким образом, потенциально будет обрабатываться многими третьими сторонами. Распределённая природа Git делает невозможным отслеживание того, где именно будет храниться и обрабатываться ваш коммит и, следовательно, ваши личные данные. Если вы не хотите принимать этот риск, пожалуйста, либо совершайте коммиты анонимно, либо воздержитесь от участия в проекте OpenTTD.
Это руководство по участию адаптировано из Bootstrap в соответствии с условиями лицензии Creative Commons Attribution 3.0 Unported License для документации Bootstrap. Уведомление GDPR адаптировано из rsyslog под лицензией GNU General Public License.
Вы можете оставить комментарий после Вход в систему
Неприемлемый контент может быть отображен здесь и не будет показан на странице. Вы можете проверить и изменить его с помощью соответствующей функции редактирования.
Если вы подтверждаете, что содержание не содержит непристойной лексики/перенаправления на рекламу/насилия/вульгарной порнографии/нарушений/пиратства/ложного/незначительного или незаконного контента, связанного с национальными законами и предписаниями, вы можете нажать «Отправить» для подачи апелляции, и мы обработаем ее как можно скорее.
Опубликовать ( 0 )