Project

General

Profile

Wiki für AqBanking

Hier entsteht nach und nach die Dokumentation für AqBanking.

Wie kann ich mich beteiligen?

Fehler melden

Bei Problemen mit der AqBanking-Familie sollten Sie sich als erstes an die Mailingliste wenden (Mailingliste AqBanking-User).

Falls Sie einen Fehler in AqBanking finden oder neue Features anregen möchten, sollten Sie im Bugtracker nachschauen, ob hier bereits ein Fehlerbericht zum Thema vorliegt.

Sollte der Fehler oder das geforderte Feature noch nicht bekannt sein, können Sie diesen direkt anlegen unter Fehler melden oder Feature anfordern

Fehlerbericht anlegen
Falls Sie einen neuen Eintrag anlegen, sollten Sie die folgenden Informationen angeben:
  • Welches Betriebssystem (Name, Version, z.B. "Debian 9")?
  • Welche Version von AqBanking? Hierzu hilft beispielsweise der folgende Befehl:
    aqbanking-cli versions
    
  • Welche Anwendung wurde benutzt (Name und Version, z.B. "KMyMoney 5.0.0")?
  • Welche Bank war beteiligt (Name, Bankleitzahl)?
  • Welcher Geschäftsvorfall wurde versucht auszuführen (z.B. "Umsatzabruf")?
Logdateien erstellen

Falls ein Fehler gefunden wurde, benötigen wir in der Regel Logdateien. Damit diese aussagekräftig sind, muß man ein paar Umgebungsvariablen setzen, um den Loglevel zu erhöhen.
Auf der Konsole (kterminal, xterm oder andere):

export AQHBCI_LOGLEVEL=info
export AQBANKING_LOGLEVEL=info
export GWEN_LOGLEVEL=info

Wenn man dann anschließend in der gleichen Konsole seine Anwendung startet (GnuCash, KMyMoney, AqFinance), erscheinen auf der Konsole viele Meldungen, die wir Entwickler benötigen, um einen Fehler
zu beheben.

Solche Logdateien können dann nach Rücksprache direkt an Martin Preuss gesendet werden (martin at libchipcard de). Solche Nachrichten sollten im Idealfall verschlüsselt werden (entsprechender Key unter
https://www.aquamaniac.de/martin-at-libchipcard-de.asc ).

Bitte niemals Logdateien an unsere Mailingliste oder an Foren senden!

Wiki aktualisieren

Vielleicht haben Sie Zeit und Lust, Dokumentation zu schreiben? Melden Sie sich am besten hier an, um Zugang zu unserem System zu bekommen. Parallel können Sie sich
auf der Mailingliste AqBanking-User anmelden, dann können Sie für den Zugriff auf das Wiki freigeschaltet werden und frei Änderungen vornehmen.

Programmieren

Wir freuen uns, wenn jemand neue Features einbauen möchte. Einige Features der letzten Zeit (z.B. RDH7, RDH9) konnten nur durch die Hilfe engagierter Mitprogrammierer realisiert werden.
Wenn Sie ebenfalls mitmachen möchten, sollten Sie sich auf der Mailingliste AqBanking-User anmelden, um eventuell einzubauende Features zu besprechen,
damit nicht möglicherweise zwei Programmierer parallel am gleichen Feature arbeiten.
Um neuen Code einzubringen, gibt es die folgenden Möglichkeiten:

  • Patches einsenden (z.B. an die Mailingliste oder an den Bugtracker)
  • eigene Kopie von AqBanking auf github anlegen und dort daran arbeiten, von da aus können wir die Änderungen dann in unseren GIT übernehmen.
  • Falls Sie sich längerfristig engagieren wollen: Auf der Mailingliste Schreib-Zugang zu unserem GIT-Repository anzufordern.

Für eingesendete Patches/Code/Änderungen bitten wir, den Code unter der "Modified BSD License" https://opensource.org/licenses/BSD-3-Clause freizugeben, damit wir die Änderungen problemlos integrieren können.

Konventionen für GIT-Branch-Namen

Inzwischen hat sich ein gewisses Muster für Zweignamen in unserem GIT eingebürgert, aus denen hervorgeht, wer einen Branch angefangen hat, wann etwa und was dort entwickelt wird.
Der Zweigname setzt sich somit aus den folgenden Bestandteilen zusammen:

  Initialen-DATUM(JahrMonat)-Zweck_des_Branches

Für einen Branch, den ich im Februar 2019 starte, und der "ein ganz tolles Feature" implementiert, waere der Name also beispielsweise:

  mp-201902-ein_ganz_tolles_Feature

Benutzer einrichten