### Contributing to the Battery-Emulator project

What can I do?
--------------

**"Help - I want to contribute something, but I don't know what?"**

You're in luck. There's various sources to contribute:
 - Improve the [Wiki documentation](https://github.com/dalathegreat/Battery-Emulator/wiki)
   - Especially battery/inverter specific pages need updating. Attach pictures of batteries, wiring diagrams, helpful info etc. 
 - Have a look at the [issue tracker](https://github.com/dalathegreat/Battery-Emulator/issues), especially issues with labels:
   - [good first issue](https://github.com/dalathegreat/Battery-Emulator/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)!
 - Use your favorite text editor to find `TODO` comments in the code
 - Ask us!
   - [Discussion page](https://github.com/dalathegreat/Battery-Emulator/discussions)
   - [Discord server](https://www.patreon.com/dala) 

## Notes on embedded system
The Battery-Emulator is a real-time control system, which performs lots of time critical operations. Some operations, like contactor control, need to complete within 10 milliseconds periodically. The resources of the ESP32 microcontroller is limited, so keeping track of CPU and memory usage is essential. Keep this in mind when coding for the system! Performance profiling the system can be done by enabling the "Enable performance profiling:" option in the webserver

## Code formatting
The project enforces a specific code formatting in the workflows. To get your code formatted properly, it is easiest to use a pre-commit hook before pushing the code to a pull request.

Before you begin, make sure you have installed Python on the system!
To install the pre-commit, open the repository via Git Bash/CMD, and run
```
pip install pre-commit
```
And then run 
```
pre-commit install
```
Then you can run the autoformat any time with the command
```
pre-commit
```
Or force it to check all files with
```
pre-commit run --all-files
```

## Local Unit test run
The Unit tests run gtest. Here is how to install this on Debian/Ubuntu and run it locally
```
sudo apt-get install libgtest-dev
sudo apt-get install cmake
```
Navigate to Battery-Emulator/test folder
```
sudo cmake CMakeLists.txt
sudo make
```