From f3623440096a96209bf0a7dab0396bb86302c001 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Simon=20St=C3=BCrz?= Date: Fri, 7 Nov 2025 12:11:04 +0100 Subject: [PATCH] Add AGENTS.md --- AGENTS.md | 25 +++++++++++++++++++++++++ plugin/evdashjsonhandler.h | 2 +- 2 files changed, 26 insertions(+), 1 deletion(-) create mode 100644 AGENTS.md diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..7247609 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,25 @@ +# Agent Instructions + +Welcome to the nymea EV-Dash experience plugin repository. Please keep the following guidelines in mind when working on this codebase: + +## Structure +- The `plugin` directory contains the Qt c++ implementation of the experience plugin + - The `EvDashJsonHandler` class provides the JSON RPC API definition and declaration of the experience + - The `EvDashWebServerResource` represents the webserver HTTP backend and handles REST API requests and file requests starting with the path /evdash +- The `dashboard` folder contains the webinterface, a html + javacript based website representing the frontend. +- The dashboard should be brandable, providing 3 colors and icons should allow to change the style of the webinterface + +## General workflow +- Keep pull request descriptions concise but informative, mentioning both user-visible changes and internal refactors. +- Prefer focused commits that touch related files together. + +## C++/Qt coding style +- Follow the Qt coding conventions: camelCase for method names and member variables beginning with `m_`. +- Keep `#include` directives alphabetised within their groups (project headers before Qt and system headers). +- Use Qt container classes where the rest of the code already does so. +- Use Qt logging helpers (`qCDebug(dcEvDashExperience())`, `qCWarning(dcEvDashExperience())`, etc.) for new diagnostics. + +## Tests and verification +- When possible, run the relevant unit or integration tests and mention them in the final summary. + +Thank you for contributing! diff --git a/plugin/evdashjsonhandler.h b/plugin/evdashjsonhandler.h index 7531621..9b51cad 100644 --- a/plugin/evdashjsonhandler.h +++ b/plugin/evdashjsonhandler.h @@ -45,7 +45,7 @@ public: QString name() const override; - // Q_INVOKABLE JsonReply *SetEnabled(const QVariantMap ¶ms); + Q_INVOKABLE JsonReply *SetEnabled(const QVariantMap ¶ms); signals: void EnabledChanged(const QVariantMap ¶ms);