WG: : Working with this repository - VDVde/OJP GitHub Wiki

Issues

If you want something changed, updated, have question. Then create an issue.

Add the relevant labels (e.g. bug, enhancement). If e.g. the specification should be changed, add the "documentation" label.

It is always good to work directly with the "code" (XSD/XML in this case).

Steps to take

make a local copy
use the current development branch for enhancements and "master" for bug fixes.
create a new branch based on that branch (git checkout next -b <new_branch_name>)
fetch latest from origin
always use Branch>New Branch from the development branch for enhancements and from master for bug fixes.
Make sure that your changes are valid (XML Spy or xmllint)
Add or update examples if needed to the examples folder
Check what changed.
For your commits use short and useful names
Improve local documentation with xs:annotation
Make reference to TRANSMODEL where possible.
When creating the Pull request always make sure, that you compare to the right branch (changes_1.1 for improvoments and master for bugs):
Always set the option "allow changes by maintainers"
Set some reviewers

Usually it is enough to check added (green) or removed (red) lines in the files tab of the PR
Always start a review with the green "Start a review"-button
Check for typos
Check the xs:documentation
Check that Transmodel is used for reference
Check if the names of elements are right
Check if the elements are defined well and encompass the use cases
Check if the specification needs to be updated as well
Check if that elements are reused.
Check if the elements are modeled as they should.
Check generated HTML with https://htmlpreview.github.io/

Changing can be done by using the blue + - sign on given lines (multiple lines can be selected.
Use the +/- to directly alter the lines in a way that can then be committed (makes it easier)
Write useful comments
Approve/Decline or Comment to finalise your review and making your comments visible:

Hints: