Coding guidelines

Java style guide for contributors.

Names

• Use PascalCase for class, interface, enum and record names.
• Use lowerCamelCase for variable and method names.
• Use UPPER_CASE for enum values.

Formatting

• Tabs.
• { on current line.

Commenting

• Utility functions should have JavaDoc comments. Utility functions include static helper methods and any core API features. For example, every implemented method in one of the Visitor classes doesn't need its own JavaDoc.

PRs won't be merged without following this guide. Eventually, a formatting Github Action will be added.