From eb228f78cb2afabd67cb1d4b420b82cdd1f9e85b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Daniel=20=C3=96ster?= <dalathegreat@gmail.com>
Date: Sun, 30 Jun 2024 22:13:55 +0300
Subject: [PATCH] Add note on embedded system

---
 CONTRIBUTING.md | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index b9ed94326..fb5acae96 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,5 +1,8 @@
 ### Contributing to the Battery-Emulator project
 
+## 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 FUNCTION_TIME_MEASUREMENT option in the USER_SETTINGS.h file
+
 ## 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.