confirmed, superuser, Administrators
539
edits
Changes
Developer GitHub Organisation (view source)
Revision as of 19:56, 24 August 2022
, 19:56, 24 August 2022Created main GitHub info page
The '''ROS GitHub Organisation''' is a group for developers of routes and software to collaborate on such routes and software. To create route projects, a template is provided which ensures that projects are in a standard form. The organisation also features open source software, such as the [[ROSPkgManager]] and [[json2ttb]]. You can view on GH here: [https://github.com/Railway-Op-Sim].
The '''Railway-Op-Sim GitHub Organisation''' is a group for developers of routes and software to collaborate on such routes and software on the code version control hosting site GitHub. The original aim of the group was to provide a central development area for the creation of route add-ons for [[Railway Operation Simulator]] where a standard can be implemented to ensure all projects are structured in a similar manner and contain all the information required to initialise a simulation. However over time the usage has extended to the creation of tools and interfaces to improve interaction with the software.
Projects hosted under the domain of the organisation are assumed to fall under an open source license (e.g. GPLv3) and be open to contributions from other developers under the condition that the correct etiquette for collaborative code writing be followed including issue opening and merging of changes through pull requests. Route add-on development is encouraged to follow the conventions set out within the GitHub [https://github.com/Railway-Op-Sim/UN-Template template repository] which also includes automated testing using the GitHub Actions Continuous Integration (CI) system. The template defines a standard directory structure for constituent files, and introduces the concept of a metadata file which contains additional useful information not covered by the existing route and timetable files. As part of the CI system if a metadata file is not found one is generated and should be updated by the author to contain correct information.
Requests for access to the GitHub organisation should be made via the [[Railway Operation Simulator]] Discord server.
== Further Information ==
* [[Introduction to Git for Development]]
* [[Project Template|Using the Add-on Template]]
* [[Continuous Integration]]
* [[Organisation Teams and Project]]