ICGE2

The second version of the introduction course game engine for the Java introduction course which is organized yearly by FIUS at the University Stuttgart.

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", "OPTIONAL" in this document are to be interpreted as described in RFC 2119.

Documentation

The ci generates documentation from the javadocs in the code. The result can be found on our github pages.

Found a bug? / Need a feature?

Please report them by creating an issue on the github issue page. Please include a full stacktrace and information to reproduce the error in case of a bug report.

Contributing

This project is managed by students part of FIUS. Nevertheless help is always highly appreciated. New features and bug fixes can be easily submitted as a pull request but there are a few rules a pull request must adhere to.

Code format

We have some scripts to check and establish the correct code format. This is also enforced by the ci for pull-requests. See scriptsAndTools

Pull requests

A pull request …

… should state clearly what it does or fixes.
… must pass all CI checks (e.g. unit tests, licence header tests and code format tests).
… must be reviewed by at least one of the maintainers.
… must be merged by one of the maintainers.
… may be reviewed by others.
… may be opened for work which is in progress but this must be opened as a draft.
… should have a reference to all relevant issues.
If it fixes them please add Fixes #xxx or Closes #xxx so that the issue is closed automatically on merge.
… should state the motivation for this pull request. (Can be a reference to an issue.)
… must adhere to the following styling guidelines:
- … must use camelCase for variables and class attributes
- … must use PascalCase for classes
- … must use snake_case for packages
- … must use UPPER_SNAKE_CASE for constants
… must contain Javadoc for all non private methods and fields.
… should contain Javadoc for all private methods.
… may contain Javadoc for all private fields.
… should not introduce new eclipse compiler warnings. Unfixable warnings should be suppressed.