Skip to content

WG: : Working with this repository

Matthias Günter edited this page Oct 17, 2023 · 1 revision

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.

Pull Request creation

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

Steps to take

  1. make a local copy image

  2. use the current development branch for enhancements and "master" for bug fixes. image

  3. create a new branch based on that branch (git checkout next -b <new_branch_name>) image

  4. fetch latest from origin

  5. always use Branch>New Branch from the development branch for enhancements and from master for bug fixes.

  6. Make sure that your changes are valid (XML Spy or xmllint)

  7. Add or update examples if needed to the examples folder

  8. Check what changed.

  9. For your commits use short and useful names

  10. Improve local documentation with xs:annotation

  11. Make reference to TRANSMODEL where possible.

  12. When creating the Pull request always make sure, that you compare to the right branch (changes_1.1 for improvoments and master for bugs): image

  13. Always set the option "allow changes by maintainers"

  14. Set some reviewers

Reviewing Pull Requests

  1. Usually it is enough to check added (green) or removed (red) lines in the files tab of the PR image
  2. Always start a review with the green "Start a review"-button
  3. Check for typos
  4. Check the xs:documentation
  5. Check that Transmodel is used for reference
  6. Check if the names of elements are right
  7. Check if the elements are defined well and encompass the use cases
  8. Check if the specification needs to be updated as well
  9. Check if that elements are reused.
  10. Check if the elements are modeled as they should.
  11. 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) image
  • Write useful comments
  • Approve/Decline or Comment to finalise your review and making your comments visible: image

Hints:

  • Always create/update the example XML
  • use xmllint to validate the xsd agains the xml examples and with itself