microsoft / microsoft/yardl

abbreviations and camelCase

Open
#186 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C++
Stars
35
Forks
14
Avg merge
5d 17h
Merged PRs (30d)
1

Description

Currently rules for fields etc enforce starting with a small letter. This feels unnatural for abbreviations, e.g. we had a fan enum value ECGTrace but that gives

the symbol name 'ECGTrace' must be camelCased matching the format ^[a-z][a-zA-Z0-9]{0,63}$

forcing us to use ecgTrace. Not a major thing, but does feel strange.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Find the validation rule that produces the quoted camelCase error and inspect any tests covering symbol-name formats. Determine how abbreviation-leading names such as ECGTrace should be handled, then update the validation and its tests so the intended abbreviation case is accepted without losing the existing naming constraints.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.