-
Notifications
You must be signed in to change notification settings - Fork 0
Development
Setup your development environment according to the instructions in Getting Started.
We have the policy to write acronyms of three of more letters in camel/pascal case, i.e., all but the first letter are written in lowercase. For example, classes may be named Uuid and Uri, variables may be named uuid and uri. This is particularly useful for readability when having compound names such as UuidResolver. We also use this notation when referring to concepts provided by existing libraries, frameworks or the like that use a different notations. For example, when referring to an EMF namespace URI, which is called nsURI in EMF, we will call it nsUri.
To contribute to a Vitruv project, please fork the appropriate project or (as an organization member) create a new branch. If you think that your contribution is complete and should be integrated into the main branch, open a pull request with an expressive description. We will review the modifications and comment on them or merge them into the master branch. In addition, automatic status checks are performed, which include compilation and tests defined in the project.
It is not possible for anyone to directly push to the main branch of a project. Every modification has to be merged from a pull request.
Ensure that the Maven build of the project works successfully, both on your local machine as well as on our build server (see Build-and-Continuous-Integration). Often, locally cached artifacts make the build work although it does not succeed on the build server, so ensure that your build also succeeds there. In addition, please ensure that your code is free of warnings.