Pflege der MAINTAINER.txt

Begonnen von betateilchen, 16 September 2017, 18:55:53

Vorheriges Thema - Nächstes Thema

betateilchen

Hallo Entwicklerkollegen,

da in 98_help.pm inzwischen auch der Maintainer und das entsprechende Unterforum zu einem Modul ermittelt und in der Hilfe ausgegeben werden, wäre es hilfreich, wenn wir uns auf folgende Konventionen bezüglich des Inhalts und der Formatierung der Datei MAINTAINER.txt verständigen könnten.


  • keine Tabulatoren in der Datei. (Vielleicht kann man das in den pre-commit hook einbauen, analog zur vorhandenen Prüfung bei CHANGED)
  • keine absoluten URLs zu einzelnen Forumbeiträgen in der letzten Spalte der Datei, sondern nur die Angabe des richtigen Unterforums

Die Tabulatoren habe ich heute alle durch Leerzeichen ersetzt. Nach Rücksprache mit Rudi habe ich heute außerdem den in jeder Zeile vorkommenden Eintrag http://forum.fhem.de entfernt, wodurch die Datei massiv an Übersichtlichkeit gewinnt.


(wo ist eigentlich die Editor-Option "Keine automatische Umwandlung in Links" geblieben?)
-----------------------
Formuliere die Aufgabe möglichst einfach und
setze die Lösung richtig um - dann wird es auch funktionieren.
-----------------------
Lesen gefährdet die Unwissenheit!

Markus M.

Zitat von: betateilchen am 16 September 2017, 18:55:53keine absoluten URLs zu einzelnen Forumbeiträgen in der letzten Spalte der Datei, sondern nur die Angabe des richtigen Unterforums

Einspruch!
Ich habe nicht umsonst einen Thread je Modul angelegt und keine grosse Lust auf eine Thread-Schnitzeljagd zu jedem einzelnen Problem.
Das ist für mich nicht schön und für die Benutzer der Module auch nicht.
FHEM dev + HomeBridge + Lenovo Flex15 + HM-CFG-USB + RFXtrx433 + Fritz!Box 7590/7580/546E

HM Aktor/Sensor/Winmatic/Keymatic/Thermostat, HUE, Netatmo Weather/Security/Heating, Xiaomi AirPurifier/Vacuum, Withings Aura/BPM/Cardio/Go/Pulse/Thermo, VSX828, Harmony, Siro ERB15LE
https://paypal.me/mm0

betateilchen

Zitat von: Markus M. am 16 September 2017, 19:11:48
Ich habe nicht umsonst einen Thread je Modul angelegt und keine grosse Lust auf eine Thread-Schnitzeljagd zu jedem einzelnen Problem.
Das ist für mich nicht schön und für die Benutzer der Module auch nicht.

Es geht nicht um schön oder nicht schön. Das Eintragen von URL in diese Datei widerspricht den von Rudi veröffentlichten Hinweisen in diesem Beitrag:

https://forum.fhem.de/index.php/topic,13092.0.html

Darin geht es nicht um einzelne Threads, sondern um Unterforen (als Nachfolger der früheren Google-"Gruppen")
-----------------------
Formuliere die Aufgabe möglichst einfach und
setze die Lösung richtig um - dann wird es auch funktionieren.
-----------------------
Lesen gefährdet die Unwissenheit!

chris1284

#3
der hardlink auf einen thread mach keinen sinn. ich habe zb keine lust zich verschiedene fragen in einem, dann unübersichtlichem thread zu folgen/beantworten. sinnvoller ist das unterforum anzugebrn. dort kann jeder hilfesuchende explizit für sein problem ein thread pro problem öffnen. theoretisch sollten user mit dem selben problem diesesn findne und sich dort anhängen. so hat man pro issue eine thread und es ist schön übersichtlich. rudi hat in den richtlinien meine ich ja auch geschrieben das man das unteforum seines modules abonieren soll um nachricht bei neuen threads zu bekommen.

gerade als es die performanceprobleme mit großen threads gab war das sehr hilfreich (da haben viele, auch der übersicht zu gute kommend, die großen threads in denen eh keiner was wieder findet geschlossen).

betateilchen

Zitat von: chris1284 am 16 September 2017, 20:30:07
sinnvoller ist das unterforum anzugebrn. dort kann jeder hilfesuchende explizit für sein problem ein thread pro problem öffnen.

Genau darum geht es. Danke!
-----------------------
Formuliere die Aufgabe möglichst einfach und
setze die Lösung richtig um - dann wird es auch funktionieren.
-----------------------
Lesen gefährdet die Unwissenheit!

betateilchen

@Rudi: wir sollten dafür Sorge tragen, dass die Datei MAINTAINER.txt sowohl im Makefile als auch im update-Prozess berücksichtigt wird.

Siehe Hinweis hier: https://forum.fhem.de/index.php/topic,76734.0.html

Am Makefile arbeite ich gerade, das update wäre Deine Baustelle.
-----------------------
Formuliere die Aufgabe möglichst einfach und
setze die Lösung richtig um - dann wird es auch funktionieren.
-----------------------
Lesen gefährdet die Unwissenheit!

Markus M.

Zitat von: chris1284 am 16 September 2017, 20:30:07rudi hat in den richtlinien meine ich ja auch geschrieben das man das unteforum seines modules abonieren soll um nachricht bei neuen threads zu bekommen.

Kann und werde ich bei "Sonstige Systeme" und "Unterstützende Dienste" (und darin liegen alle meine Module) aber nicht tun, weil mich 99.9% nicht betreffen.
Der verlinkte Post ist von 2013 - mit der heutigen Menge an neuen Threads geht das schlicht nicht mehr ohne Keyword Alerts etc.
FHEM dev + HomeBridge + Lenovo Flex15 + HM-CFG-USB + RFXtrx433 + Fritz!Box 7590/7580/546E

HM Aktor/Sensor/Winmatic/Keymatic/Thermostat, HUE, Netatmo Weather/Security/Heating, Xiaomi AirPurifier/Vacuum, Withings Aura/BPM/Cardio/Go/Pulse/Thermo, VSX828, Harmony, Siro ERB15LE
https://paypal.me/mm0

betateilchen

Es ergibt für mich überhaupt keinen Sinn, sämtliche Fragen zu einem Modul in einem einzigen Thread behandeln zu wollen. Das dient weder der Übersichtlichkeit noch ist es für Hilfesuchende tatsächlich hilfreich.

Wenn ein Anwender einen neuen Thread mit einer Frage zu Deinem Modul eröffnet, nützt es Dir die Eingabe eines bestimmten Threads in der MAINTAINER.txt überhaupt nichts. Da Du das Unterforum nicht abonniert hast, bekommst Du die Frage vermutlich erstmal gar nicht mit.

Das ist nicht der Weg, wie man als maintainer eines Moduls denken und arbeiten sollte, wenn man sich wirklich um Problemfälle kümmern möchte.

(Meine persönliche Meinung)
-----------------------
Formuliere die Aufgabe möglichst einfach und
setze die Lösung richtig um - dann wird es auch funktionieren.
-----------------------
Lesen gefährdet die Unwissenheit!

CoolTux

Hallo Markus,

Ich denke auch das es ein falscher Ansatz ist alle Probleme eines Modules in einem Thread lösen zu wollen. Das führt am Ende zu mehr Aufwand. Könnte ein Problem zu Deinem Modul in einem separaten Thread mit 3 Antworten gelöst werden und ein Suchender mit selben Problem so schnell zur Lösung finden, würde es in einem 100 Antwort Thread sicherlich ewig dauern zu suchen und somit kommt es zu mehr Fragen mit dem selben Inhalt.

Ich stimme daher Udos Aussage voll und ganz zu.



Grüße
Du musst nicht wissen wie es geht! Du musst nur wissen wo es steht, wie es geht.
Support me to buy new test hardware for development: https://www.paypal.com/paypalme/MOldenburg
My FHEM Git: https://git.cooltux.net/FHEM/
Das TuxNet Wiki:
https://www.cooltux.net

Markus M.

Wir reden glaube ich ein wenig aneinander vorbei.

Der Grund warum der Einzel-Thread besser funktioniert ist für mich keinesfalls ideeller sondern rein technischer Natur.
Darauf habe ich Push Notifications und die durchschnittliche Antwortzeit liegt daher eher bei Minuten statt Stunden.
Das Unterforum kann ich so aber nicht abonnieren, da ich sonst zu viele davon bekomme.

Einzelnen Threads würden das Forum übersichtlicher machen, ich habe aber keine Möglichkeit dass die Informationen automatisch zu mir kommen - ich müsste sie mir aktiv suchen. Und das geht eben nicht in der Zigarettenpause im Büro sondern ich muss dafür extra Zeit aufwenden - die ich ehrlich gesagt nicht habe :(

Gibt es seitens der Forum Software eine Möglichkeit dieses Dilemma technisch zu lösen, z.B. über Keyword Alerts?
FHEM dev + HomeBridge + Lenovo Flex15 + HM-CFG-USB + RFXtrx433 + Fritz!Box 7590/7580/546E

HM Aktor/Sensor/Winmatic/Keymatic/Thermostat, HUE, Netatmo Weather/Security/Heating, Xiaomi AirPurifier/Vacuum, Withings Aura/BPM/Cardio/Go/Pulse/Thermo, VSX828, Harmony, Siro ERB15LE
https://paypal.me/mm0

igami

Zitat von: Markus M. am 17 September 2017, 10:40:52
Gibt es seitens der Forum Software eine Möglichkeit dieses Dilemma technisch zu lösen, z.B. über Keyword Alerts?
Das kann man doch sicherlich mit FHEM und dem rssFeed Modul lösen ;)
Pi3 mit fhem.cfg + DbLog/logProxy
Komm vorbei zum FHEM Treffen im Kreis Gütersloh! Das nächste Mal im April 2020.

MAINTAINER: archetype, LuftdatenInfo, monitoring, msgDialog, Nmap, powerMap
ToDo: AVScene, FluxLED

CoolTux

Es ist also ein sagen wir persönliches Einzelschicksal was Dich zu Deinem berechtigten Einspruch gebracht hat. Verstehe.
Nichts desto trotz hoffe ich das Du auch verstehst wenn mehrheitlich oder durch Rudi entschieden/vorgeschrieben wird das in Zukunft solche Einträge in der Maintainer Datei nicht mehr zu stehen haben.


Grüße
Du musst nicht wissen wie es geht! Du musst nur wissen wo es steht, wie es geht.
Support me to buy new test hardware for development: https://www.paypal.com/paypalme/MOldenburg
My FHEM Git: https://git.cooltux.net/FHEM/
Das TuxNet Wiki:
https://www.cooltux.net

dev0

Zitat von: Markus M. am 17 September 2017, 10:40:52
Gibt es seitens der Forum Software eine Möglichkeit dieses Dilemma technisch zu lösen, z.B. über Keyword Alerts?
Ich habe es bisher selbst so gelöst, dass mein MTA auf dem Mailserver in den eingehenden Email-Benachrichtigungen nach Schlüsselwörtern sucht und die Mails, dann in entsprechende Unterordner verschiebt. Das wird auch ein normales Emailprogramm können, aber dann halt dezentral. Eine Lösung auf Forumsebene wäre für die meisten Entwickler sicher elegnater...

HCS

Zitat von: CoolTux am 17 September 2017, 10:47:56
Es ist also ein sagen wir persönliches Einzelschicksal was Dich zu Deinem berechtigten Einspruch gebracht hat.
Wie kommst Du zu dem Schluss, ohne die anderen Schicksale zu kennen?

Das Problem ist, dass man einen viel zu breiten Raum abonnieren muss.
Ich kümmere mich um (um mal nur zwei rauszugreifen) LaCrosse und Elero, beides in "Sonstige Systeme".
Da ist aber auch "Xiaomi", "G-Homa WiFi-Steckdose", "Signalduino", "Schellenberg Smart Home Zentrale", und eine gefühlt unendlich lange Liste mehr, was mich absolut nicht interessiert / betrifft.

Aktuell ist es kaum möglich, gezielt das zu bekommen, worauf man reagieren sollte und den ganzen Rest nicht.

CoolTux

Zitat von: HCS am 17 September 2017, 11:07:33
Wie kommst Du zu dem Schluss, ohne die anderen Schicksale zu kennen?
Die Antwort zu Deiner Frage hast Du bereits selbst gegeben. Ich kannte keine anderen Schicksale daher mein Schluss. Man kann nichts betrachten was einem nicht bekannt ist.
Wenn sich mehr melden muss die Betrachtung erweitert/überdacht werden.
Du musst nicht wissen wie es geht! Du musst nur wissen wo es steht, wie es geht.
Support me to buy new test hardware for development: https://www.paypal.com/paypalme/MOldenburg
My FHEM Git: https://git.cooltux.net/FHEM/
Das TuxNet Wiki:
https://www.cooltux.net