jamulussoftware / jamulussoftware/jamulus

Logging: Make log messages consistent

Offen
#1,464 3 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

feature request
Vorherrschende Sprache
C
Sterne
1.1k
Forks
248
Ø Merge
2 T. 3 Std.
Gemergte PRs (30 T.)
9

Beschreibung

Log messages (especially from `src/main.cpp`) should be checked for consistency.

- Uppercase/lowercase (as suggested by @drummer1154 in #1284)
- Trailing dots
- Indentation
- Leading characters such as `-`

The rules (e.g. leading `-` for command line flag-related output?) should be documented somewhere.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne damit, die Logging-Aufrufstellen in src/main.cpp zu überprüfen, und verfolge zugehörige Meldungen im gesamten Quellbaum. Lies die in Issue #1284 referenzierte Diskussion zur Konsistenz und ermittle anschließend die vereinbarten Regeln des Projekts für Groß- und Kleinschreibung, Zeichensetzung, Einrückung und führende Zeichen. Als erledigt gilt die Aufgabe, wenn die betroffenen Meldungen den dokumentierten Regeln folgen und die Regeln an einer zugänglichen Stelle dokumentiert sind.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
cpp
Bereich
documentation, observability-sre
Issue-Typ
Refactoring
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.