Внести Свой Вклад > Разработка Кода

Частные Изменения

Любой желающий может скачать исходный код Open Rails и внести изменения в соответствии с со своими потребностями - то есть создать персональную версию.

Общественные Изменения

Если ваши изменения могут быть полезны другим пользователям, мы рекомендуем вам представить их для включения в продукт. Мы ответим на все заявки и отметим Ваши заслуги в отчете о предоставленных материалах для включения в проект.

Нажмите здесь для получения подробных советов и инструкций по внесению вклада в Open Rails.

Система контроля версий

Проект Open Rails использует Git в качестве системы управления версиями и редакциями для нашего программного обеспечения. Редакции хранятся в публичном хранилище по адресу GitHub.com и могут быть сравнены, восстановлены и объединены, так что версии безопасны и несколько разработчиков могут работать независимо друг от друга без (слишком большого) конфликта.

С Вашего компьютера вы можете просто просмотреть репозиторий из веб-браузера. GitHub.com предоставляет настольную программу GitHub для взаимодействия между GitHub.com и ваш компьютер (только для 64-битной Windows). Другие программы Windows-это SourceTree и TortoiseGit, а также Visual Studio включает в себя инструмент Git.

Основными папками в репозитории являются:
Аддоны-вспомогательные файлы, поставляемые вместе с установочным пакетом
Архитектура-незавершённый эксперимент по реструктуризации программы
Документация-руководство по эксплуатации и другая документация
Программа-пустое пространство для исполняемых файлов после их компиляции
Source - основные файлы исходного кода
Веб-сайт-источник для этого веб-сайта

Компиляция проекта OpenRails

Чтобы скомпилировать и отладить исходный код Open Rails, убедитесь, что у вас установлены следующие продукты Microsoft:
Visual Studio 2017 или 2019, любое издание. Издание для сообщества является бесплатным
(Примечание 1: чтобы сэкономить место на диске, все, что вам нужно, - это опция Windows > .NET Development)
(Примечание 2: Установите это перед Microsoft XNA Framework Redistributable 3.1)
Microsoft XNA Framework Redistributable 3.1

После того как вы скачали код:

1.Откройте исходную папку (Source)
2.Дважды щелкните по файлу ORTS.sln для запуска Visual Studio с проектом Open Rails
3.В меню Visual Studio выберите построение > перестроить решение
4.В строке состояния (слева внизу) дождитесь сообщения "всё перестроено успешно".

Исполняемые файлы теперь были построены и помещены в папку Программы.

Запуск кода RunActivity.exe в режиме отладки

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

В меню Visual Studio,
1.Выберите Вид > Обозреватель Решений
2.В окне Обозреватель решений (справа) щелкните правой кнопкой мыши на RunActivity выберите Properties
3.Используйте вкладку отладка (слева), чтобы открыть окно отладки.
4.В поле "аргументы командной строки" введите путь к действию, которое вы хотите запустить: например, "c:\personal\msts\routes\lps\activities\ls1.act". Используйте кавычки, если путь содержит пробелы в нем.
5.Ниже установите флажок "включить отладку собственного кода"
6.Нажмите клавишу F5, чтобы запустить RunActivity.exe, используя ваше действие.

Запуск набора тестов

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

После открытия решения в Visual Studio,
1.Выберите Проверить > Проверить Проводник
2.Дождитесь заполнения тестов на панели обозревателя тестов
3.В левом верхнем углу этой панели выберите пункт "Выполнить все тесты" или нажмите Ctrl-R, а затем A.

Политика внесения изменений в код

Чтобы позволить многим людям вносить свой вклад непосредственно в Open Rails успешно, у нас есть политика, позволяющая следить за тем, откуда происходят изменения и какие изменения разрешены. Политика заключается в следующем:
1.Все изменения должны быть одним из следующих:
Простые исправления ошибок, со ссылкой на ошибку
Целевые исправления ошибок, со ссылкой на ошибку
Утвержденные планы со ссылкой на проект
Обновления документации или локализации (хранятся отдельно от изменений кода)
2.Простое означает не более чем несколько строк изменений и отсутствие неопределенности в отношении изменения логики.
3.Целевой означает, что "веха" устанавливается на следующую запланированную стабильную версию.
4.Утверждено означает, что "направление" является "утвержденным", "Контрольная цель" не установлена или установлена на следующую запланированную стабильную версию, и по крайней мере 7 дней обсуждения состоялось.

Для членов группы разработчиков эти политики определены более подробно в разделах политика для изменений кода и Политика для схем элементов.