jamulussoftware / jamulussoftware/jamulus

Logging: Make log messages consistent

Open
#1,464 3 comments 0 reactions 0 assignees View on GitHub
feature request
Dominant language
C
Stars
1.1k
Forks
248
Avg merge
2d 3h
Merged PRs (30d)
9

Description

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.

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the logging call sites in src/main.cpp and follow related messages across the source tree. Read the consistency discussion referenced in issue #1284, then identify the project’s agreed rules for casing, punctuation, indentation, and leading characters. Done means the affected messages follow documented rules and the rules are documented somewhere accessible.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
documentation, observability-sre
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.