eclipse-score / eclipse-score/lifecycle

Enforce member variable naming schema

Open
#590 0 comments 0 reactions 0 assignees View on GitHub
cleanup good first issue
Dominant language
C++
Stars
6
Forks
34
Avg merge
2d 3h
Merged PRs (30d)
80

Description

### What

To my understanding (may be this needs clarification @NicolasFussberger ), we are using this naming schema for member variable
`my_member_variable_`

However in alive_monitor code (and most probably also somewhere else) for historical reasons there are also other styles used, like `m_recovery_client` or `_my_member_variable`.

So the task here is to unify this with a clang-tidy rule. Also make sure that introduction of wrongly named variables is not possible. Normally this should work out of the box, as clang-tidy is executed as pre-commit hook.

### Acceptance Criteria (DoD)

- Unified naming schema
- Introduction of invalid named member variables is impossible (as long as precommit hook is not skipped)

### How

_No response_

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating the clang-tidy configuration and pre-commit hook, then inspect member-variable naming in the alive_monitor code and elsewhere. Confirm the intended trailing-underscore schema and the full set of existing variants with the maintainers. Done means existing member variables are unified and the hook rejects newly introduced invalid names.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
tooling
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Needs clarification
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.