CODING_CONVENTIONS.md

Coding conventions

This document outlines the coding standards and best practices for BaSyx Java. Adhering to these conventions will help maintain code quality, enhance readability, and ensure that our codebase is easy to maintain and scale.

General Principles

1. Consistency: All contributors are expected to follow the agreed-upon styles and patterns defined in this document.
2. Readability and Maintainability: Write clear, understandable code that is easy to maintain and extend.
3. Performance Considerations: Always consider performance implications when writing your code.

BaSyx Java Code Formatter

When working with BaSyx Java ind Eclipse, you should use the BaSyx Java code formatter. The formatter is available in the BaSyx_Formatting.xml file in the docs directory of the repository. To use it, follow these steps:

1. Download the BaSyx_Formatting.xml file.
2. In Eclipse, go to Window > Preferences > Java > Code Style > Formatter.
3. Click on Import and select the BaSyx_Formatting.xml file.
4. Click Apply and Close.