Dev:Guideline for participating in the development process: Difference between revisions
| [unchecked revision] | [unchecked revision] |
| Line 24: | Line 24: | ||
===Contributing examples=== | ===Contributing examples=== | ||
After the new subschema is published, you can improve the usability of railML® by contributing examples. | |||
<!-- A page [[dev:Examples]] is planned. please, add the link as soon as it is published. --> | |||
===parallel: Weiterentwicklung Wiki=== | ===parallel: Weiterentwicklung Wiki=== | ||
Revision as of 18:57, 4 February 2016
Guideline for participating in the development process
This guideline is supposed to explain the development of the railML® schema and how you can contribute.
As a developer of railML®-based application you may at some point reach limitations of railML® or even bugs. As the schema is being developed in an open source style by the community, we invite you to help improving railML® by reporting your demands and participating in finding a solution.
The provided development proces
Submit your issue to the forum
If you find a bug or have demand for a new subschema or attribute, you should first put it forth in the railML® forum. Sometimes the discussion there will show, that something you considered to be a bug is in fact a feature, or that a feature you demanded already exists. As an open community, other Users, developers and coordinators will try to help you finding a soluion to your issue.
Discussion process
If the issue finds resonance, the subschema coordinator will moderate a discussion as to formulate a development task (or discard the issue). To contact the coordinators directly, see http://www.railml.org/en/user/subschemes.html.
Ticket
As the result of the discussion process, the development task will be formulated as a ticket.
Workaround
Paralelly with the devellopment of the new subschema or attribute, the community may devellop a workaround. This usually takes place as part of the forum dicussion. The working horse for creating workarounds is the any-attribute. See CO:usingAny for a guide.
Development within the Subversion Repository
The new subschema will be develloped within the Subversion Repository (SVN). Although the SVN is not public, we appreciate your contributions. Please, contact the coordinator to participate in this step.
Release
As the devellopers finish the new subschema, it will be released. The releasement usually follows the version cycles of railML®. See Dev:Downloading_and_using_railML® to learn how to obtain the current schema, or downoad it directly from http://www.railml.org/en/developers/download.html.
Contributing examples
After the new subschema is published, you can improve the usability of railML® by contributing examples.