canonical/mir

Unify mousekeys/mouse keys naming

Open

#3,901 opened on Apr 18, 2025

View on GitHub
 (0 comments) (0 reactions) (0 assignees)C++ (137 forks)auto 404
Good first issue

Repository metrics

Stars
 (775 stars)
PR merge metrics
 (PR metrics pending)

Description

Throughout the code, mousekeys switches between these two styles: mousekeys (one word), and mouse-keys (two words). Fortunately, most classes/symbols follow the pattern MouseKeys*, but code comments, docs, and config options deviate and use mouse-keys. As far as I know, most "user facing" stuff uses the aforementioned pattern, so it's mostly consistent from the point of view of users. But it could be confusing to new contributors to switch between mousekeys and mouse[-_ ]keys constantly.

Contributor guide

Research direction
Search for all occurrences of 'mouse keys' and 'mouse keys' in the codebase and replace with 'mousekeys' following the existing class naming convention.
Tech stack
cpp
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85