Commit Rules
-
Code to be committed must compile.
-
Use UTF-8 as file encoding.
Otherwise it may not compile on all machines.
-
By default, only commit to your personal contrib.
Do not commit to
org.matsim.*unless you are the maintainer of a package/module inorg.matsim.*. -
Create Pull-Requests for changes in
org.matsim.*.Do not directly commit to
org.matsim.*, but create a pull request with the changes you want to apply.We use conventional commit messages for the Pull-Requests. Don’t get too creative with scopes, but try use one of the scopes that is already being used or none at all, as otherwise the generated changelog might become too cluttered.
-
Write useful commit messages.
-
Write your commit messages in English.
-
Do not commit personal data (=non-code) files to the repository.
Exception is data for test cases, which must be committed to
test/input/*. See the detailed discussion of this topic.